owntone-server/src/remote_pairing.c

813 lines
18 KiB
C

/*
* Copyright (C) 2010 Julien BLACHE <jb@jblache.org>
*
* iTunes - Remote pairing hash function published by Michael Paul Bailey
* <http://jinxidoru.blogspot.com/2009/06/itunes-remote-pairing-code.html>
* Simplified version using standard MD5 published by Jeff Sharkey
* <http://jsharkey.org/blog/2009/06/21/itunes-dacp-pairing-hash-is-broken/>
*
* Pairing process based on the work by
* - Michael Croes
* <http://blog.mycroes.nl/2008/08/pairing-itunes-remote-app-with-your-own.html>
* - Jeffrey Sharkey
* <http://dacp.jsharkey.org/>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <fcntl.h>
#include <stdint.h>
#include <inttypes.h>
#include <errno.h>
#ifdef HAVE_EVENTFD
# include <sys/eventfd.h>
#endif
#include <event2/event.h>
#include <event2/buffer.h>
#include <event2/http.h>
#include <gcrypt.h>
#include "logger.h"
#include "commands.h"
#include "conffile.h"
#include "mdns.h"
#include "misc.h"
#include "db.h"
#include "remote_pairing.h"
#include "listener.h"
struct remote_info {
struct pairing_info pi;
char *paircode;
char *pin;
unsigned short v4_port;
unsigned short v6_port;
char *v4_address;
char *v6_address;
struct evhttp_connection *evcon;
};
/* Main event base, from main.c */
extern struct event_base *evbase_main;
static pthread_mutex_t remote_lck;
static struct remote_info *remote_info;
static struct commands_base *cmdbase;
/* iTunes - Remote pairing hash */
static char *
itunes_pairing_hash(char *paircode, char *pin)
{
char hash[33];
char ebuf[64];
uint8_t *hash_bytes;
size_t hashlen;
gcry_md_hd_t hd;
gpg_error_t gc_err;
int i;
if (strlen(paircode) != 16)
{
DPRINTF(E_LOG, L_REMOTE, "Paircode length != 16, cannot compute pairing hash\n");
return NULL;
}
if (strlen(pin) != 4)
{
DPRINTF(E_LOG, L_REMOTE, "Pin length != 4, cannot compute pairing hash\n");
return NULL;
}
gc_err = gcry_md_open(&hd, GCRY_MD_MD5, 0);
if (gc_err != GPG_ERR_NO_ERROR)
{
gpg_strerror_r(gc_err, ebuf, sizeof(ebuf));
DPRINTF(E_LOG, L_REMOTE, "Could not open MD5: %s\n", ebuf);
return NULL;
}
gcry_md_write(hd, paircode, 16);
/* Add pin code characters on 16 bits - remember Mac OS X is
* all UTF-16 (wchar_t).
*/
for (i = 0; i < 4; i++)
{
gcry_md_write(hd, pin + i, 1);
gcry_md_write(hd, "\0", 1);
}
hash_bytes = gcry_md_read(hd, GCRY_MD_MD5);
if (!hash_bytes)
{
DPRINTF(E_LOG, L_REMOTE, "Could not read MD5 hash\n");
return NULL;
}
hashlen = gcry_md_get_algo_dlen(GCRY_MD_MD5);
for (i = 0; i < hashlen; i++)
sprintf(hash + (2 * i), "%02X", hash_bytes[i]);
gcry_md_close(hd);
return strdup(hash);
}
/* Operations on the remote list must happen
* with the list lock held by the caller
*/
static struct remote_info *
create_remote(void)
{
struct remote_info *ri;
ri = calloc(1, sizeof(struct remote_info));
if (!ri)
{
DPRINTF(E_WARN, L_REMOTE, "Out of memory for struct remote_info\n");
return NULL;
}
return ri;
}
static void
unlink_remote(struct remote_info *ri)
{
if (ri == remote_info)
remote_info = NULL;
else
DPRINTF(E_LOG, L_REMOTE, "WARNING: struct remote_info not found in list; BUG!\n");
}
static void
free_remote(struct remote_info *ri)
{
if (ri->paircode)
free(ri->paircode);
if (ri->pin)
free(ri->pin);
if (ri->v4_address)
free(ri->v4_address);
if (ri->v6_address)
free(ri->v6_address);
free_pi(&ri->pi, 1);
free(ri);
}
static void
remove_remote(struct remote_info *ri)
{
unlink_remote(ri);
free_remote(ri);
}
static void
remove_remote_address_byid(const char *id, int family)
{
struct remote_info *ri = NULL;
if (remote_info && strcmp(remote_info->pi.remote_id, id) == 0)
ri = remote_info;
if (!ri)
{
DPRINTF(E_WARN, L_REMOTE, "Remote %s not found in list\n", id);
return;
}
switch (family)
{
case AF_INET:
if (ri->v4_address)
{
free(ri->v4_address);
ri->v4_address = NULL;
}
break;
case AF_INET6:
if (ri->v6_address)
{
free(ri->v6_address);
ri->v6_address = NULL;
}
break;
}
if (!ri->v4_address && !ri->v6_address)
remove_remote(ri);
}
static int
add_remote_mdns_data(const char *id, int family, const char *address, int port, char *name, char *paircode)
{
char *check_addr;
int ret;
if (remote_info && strcmp(remote_info->pi.remote_id, id) == 0)
{
DPRINTF(E_DBG, L_REMOTE, "Remote id %s found\n", id);
free_pi(&remote_info->pi, 1);
ret = 1;
}
else
{
DPRINTF(E_DBG, L_REMOTE, "Remote id %s not known, adding\n", id);
if (remote_info)
{
DPRINTF(E_DBG, L_REMOTE, "Removing existing remote with id %s\n", remote_info->pi.remote_id);
remove_remote(remote_info);
}
remote_info = create_remote();
ret = 0;
}
free(remote_info->paircode);
free(remote_info->pi.remote_id);
remote_info->pi.remote_id = strdup(id);
switch (family)
{
case AF_INET:
free(remote_info->v4_address);
remote_info->v4_address = strdup(address);
remote_info->v4_port = port;
check_addr = remote_info->v4_address;
break;
case AF_INET6:
free(remote_info->v6_address);
remote_info->v6_address = strdup(address);
remote_info->v6_port = port;
check_addr = remote_info->v6_address;
break;
default:
DPRINTF(E_LOG, L_REMOTE, "Unknown address family %d\n", family);
check_addr = NULL;
break;
}
if (!remote_info->pi.remote_id || !check_addr)
{
DPRINTF(E_LOG, L_REMOTE, "Out of memory for remote pairing data\n");
remove_remote(remote_info);
return -1;
}
remote_info->pi.name = name;
remote_info->paircode = paircode;
return ret;
}
static int
add_remote_pin_data(const char *pin)
{
if (!remote_info)
{
DPRINTF(E_LOG, L_REMOTE, "No remote known from mDNS, ignoring\n");
return REMOTE_ERROR;
}
DPRINTF(E_DBG, L_REMOTE, "Adding pin to remote '%s'\n", remote_info->pi.name);
free(remote_info->pin);
remote_info->pin = strdup(pin);
return 0;
}
/* Thread: main (pairing) */
static void
pairing_request_cb(struct evhttp_request *req, void *arg)
{
struct remote_info *ri;
struct evbuffer *input_buffer;
uint8_t *response;
char guid[17];
int buflen;
int response_code;
int len;
int i;
int ret;
ri = (struct remote_info *)arg;
if (!req)
{
DPRINTF(E_LOG, L_REMOTE, "Empty pairing request callback\n");
ret = REMOTE_ERROR;
goto cleanup;
}
response_code = evhttp_request_get_response_code(req);
if (response_code != HTTP_OK)
{
if (ri->v6_address)
{
if (response_code != 0)
DPRINTF(E_LOG, L_REMOTE, "Pairing failed with '%s' ([%s]:%d), HTTP response code %d\n", ri->pi.name, ri->v6_address, ri->v6_port, response_code);
else
DPRINTF(E_LOG, L_REMOTE, "Pairing failed with '%s' ([%s]:%d), no reply from Remote\n", ri->pi.name, ri->v6_address, ri->v6_port);
}
else
{
if (response_code != 0)
DPRINTF(E_LOG, L_REMOTE, "Pairing failed with '%s' (%s:%d), HTTP response code %d\n", ri->pi.name, ri->v4_address, ri->v4_port, response_code);
else
DPRINTF(E_LOG, L_REMOTE, "Pairing failed with '%s' (%s:%d), no reply from Remote\n", ri->pi.name, ri->v4_address, ri->v4_port);
}
ret = REMOTE_INVALID_PIN;
goto cleanup;
}
input_buffer = evhttp_request_get_input_buffer(req);
buflen = evbuffer_get_length(input_buffer);
if (buflen < 8)
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s/%s: pairing response too short\n", ri->pi.remote_id, ri->pi.name);
ret = REMOTE_ERROR;
goto cleanup;
}
response = evbuffer_pullup(input_buffer, -1);
if ((response[0] != 'c') || (response[1] != 'm') || (response[2] != 'p') || (response[3] != 'a'))
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s/%s: unknown pairing response, expected cmpa\n", ri->pi.remote_id, ri->pi.name);
ret = REMOTE_ERROR;
goto cleanup;
}
len = (response[4] << 24) | (response[5] << 16) | (response[6] << 8) | (response[7]);
if (buflen < 8 + len)
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s/%s: pairing response truncated (got %d expected %d)\n",
ri->pi.remote_id, ri->pi.name, buflen, len + 8);
ret = REMOTE_ERROR;
goto cleanup;
}
response += 8;
for (; len > 0; len--, response++)
{
if ((response[0] != 'c') || (response[1] != 'm') || (response[2] != 'p') || (response[3] != 'g'))
continue;
else
{
len -= 8;
response += 8;
break;
}
}
if (len < 8)
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s/%s: cmpg truncated in pairing response\n", ri->pi.remote_id, ri->pi.name);
ret = REMOTE_ERROR;
goto cleanup;
}
for (i = 0; i < 8; i++)
sprintf(guid + (2 * i), "%02X", response[i]);
ri->pi.guid = strdup(guid);
DPRINTF(E_LOG, L_REMOTE, "Pairing succeeded with Remote '%s' (id %s), GUID: %s\n", ri->pi.name, ri->pi.remote_id, guid);
ret = db_pairing_add(&ri->pi);
if (ret < 0)
{
DPRINTF(E_LOG, L_REMOTE, "Failed to register pairing!\n");
ret = REMOTE_ERROR;
goto cleanup;
}
cleanup:
evhttp_connection_free(ri->evcon);
free_remote(ri);
listener_notify(LISTENER_PAIRING);
commands_exec_end(cmdbase, ret);
}
/* Thread: main (pairing) */
static int
send_pairing_request(struct remote_info *ri, char *req_uri, int family)
{
struct evhttp_connection *evcon;
struct evhttp_request *req;
char *address;
unsigned short port;
int ret;
switch (family)
{
case AF_INET:
if (!ri->v4_address)
return -1;
address = ri->v4_address;
port = ri->v4_port;
break;
case AF_INET6:
if (!ri->v6_address)
return -1;
address = ri->v6_address;
port = ri->v6_port;
break;
default:
return -1;
}
evcon = evhttp_connection_base_new(evbase_main, NULL, address, port);
if (!evcon)
{
DPRINTF(E_LOG, L_REMOTE, "Could not create connection for pairing with %s\n", ri->pi.name);
return -1;
}
req = evhttp_request_new(pairing_request_cb, ri);
if (!req)
{
DPRINTF(E_WARN, L_REMOTE, "Could not create HTTP request for pairing\n");
goto request_fail;
}
ret = evhttp_make_request(evcon, req, EVHTTP_REQ_GET, req_uri);
if (ret < 0)
{
DPRINTF(E_WARN, L_REMOTE, "Could not make pairing request\n");
goto request_fail;
}
DPRINTF(E_DBG, L_REMOTE, "Pairing requested to %s\n", req_uri);
ri->evcon = evcon;
return 0;
request_fail:
evhttp_connection_free(evcon);
return -1;
}
/* Thread: main (pairing) */
static int
do_pairing(struct remote_info *ri)
{
char req_uri[128];
char *pairing_hash;
int ret;
pairing_hash = itunes_pairing_hash(ri->paircode, ri->pin);
if (!pairing_hash)
{
DPRINTF(E_LOG, L_REMOTE, "Could not compute pairing hash!\n");
goto hash_fail;
}
DPRINTF(E_DBG, L_REMOTE, "Pairing hash for %s/%s: %s\n", ri->pi.remote_id, ri->pi.name, pairing_hash);
/* Prepare request URI */
/* The servicename variable is the mDNS service group name; currently it's
* a hash of the library name, but in iTunes the service name and the library
* ID (DbId) are different (see comment in main.c).
* Remote uses the service name to perform mDNS lookups.
*/
ret = snprintf(req_uri, sizeof(req_uri), "/pair?pairingcode=%s&servicename=%016" PRIX64, pairing_hash, libhash);
free(pairing_hash);
if ((ret < 0) || (ret >= sizeof(req_uri)))
{
DPRINTF(E_WARN, L_REMOTE, "Request URI for pairing exceeds buffer size\n");
goto req_uri_fail;
}
/* Fire up the request */
if (ri->v6_address)
{
ret = send_pairing_request(ri, req_uri, AF_INET6);
if (ret == 0)
return 0;
DPRINTF(E_WARN, L_REMOTE, "Could not send pairing request on IPv6\n");
free(ri->v6_address);
ri->v6_address = NULL;
}
ret = send_pairing_request(ri, req_uri, AF_INET);
if (ret < 0)
{
DPRINTF(E_WARN, L_REMOTE, "Could not send pairing request on IPv4\n");
goto pairing_fail;
}
return 0;
pairing_fail:
req_uri_fail:
hash_fail:
free_remote(ri);
return -1;
}
/* Thread: main (mdns) */
static void
touch_remote_cb(const char *name, const char *type, const char *domain, const char *hostname, int family, const char *address, int port, struct keyval *txt)
{
const char *p;
char *devname;
char *paircode;
int ret;
if (port < 0)
{
/* If Remote stops advertising itself, the pairing either succeeded or
* failed; any subsequent attempt will need a new pairing pin, so
* we can just forget everything we know about the remote.
*/
CHECK_ERR(L_REMOTE, pthread_mutex_lock(&remote_lck));
remove_remote_address_byid(name, family);
CHECK_ERR(L_REMOTE, pthread_mutex_unlock(&remote_lck));
}
else
{
/* Get device name (DvNm field in TXT record) */
p = keyval_get(txt, "DvNm");
if (!p)
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s: no DvNm in TXT record!\n", name);
return;
}
if (*p == '\0')
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s: DvNm has no value\n", name);
return;
}
devname = strdup(p);
if (!devname)
{
DPRINTF(E_LOG, L_REMOTE, "Out of memory for device name\n");
return;
}
/* Get pairing code (Pair field in TXT record) */
p = keyval_get(txt, "Pair");
if (!p)
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s: no Pair in TXT record!\n", name);
free(devname);
return;
}
if (*p == '\0')
{
DPRINTF(E_LOG, L_REMOTE, "Remote %s: Pair has no value\n", name);
free(devname);
return;
}
paircode = strdup(p);
if (!paircode)
{
DPRINTF(E_LOG, L_REMOTE, "Out of memory for paircode\n");
free(devname);
return;
}
DPRINTF(E_LOG, L_REMOTE, "Discovered remote '%s' (id %s) at %s:%d, paircode %s\n", devname, name, address, port, paircode);
/* Add the data to the list, adding the remote to the list if needed */
CHECK_ERR(L_REMOTE, pthread_mutex_lock(&remote_lck));
ret = add_remote_mdns_data(name, family, address, port, devname, paircode);
if (ret < 0)
{
DPRINTF(E_WARN, L_REMOTE, "Could not add Remote mDNS data, id %s\n", name);
free(devname);
free(paircode);
}
CHECK_ERR(L_REMOTE, pthread_mutex_unlock(&remote_lck));
}
listener_notify(LISTENER_PAIRING);
}
/*
* Returns the remote name of the current active pairing request as an allocated string (needs to be freed by the caller)
* or NULL in case there is no active pairing request.
*
* Thread: httpd
*/
char *
remote_pairing_get_name(void)
{
char *remote_name;
DPRINTF(E_DBG, L_REMOTE, "Get pairing remote name\n");
CHECK_ERR(L_REMOTE, pthread_mutex_lock(&remote_lck));
if (remote_info)
remote_name = strdup(remote_info->pi.name);
else
remote_name = NULL;
CHECK_ERR(L_REMOTE, pthread_mutex_unlock(&remote_lck));
return remote_name;
}
/* Thread: main (pairing) */
static enum command_state
pairing_pair(void *arg, int *retval)
{
char *pin = arg;
struct remote_info *ri;
int ret;
CHECK_ERR(L_REMOTE, pthread_mutex_lock(&remote_lck));
ret = add_remote_pin_data(pin);
if (ret == 0 && remote_info && remote_info->paircode && remote_info->pin)
{
ri = remote_info;
unlink_remote(ri);
ret = do_pairing(ri);
}
CHECK_ERR(L_REMOTE, pthread_mutex_unlock(&remote_lck));
if (ret < 0)
{
*retval = ret;
return COMMAND_END;
}
// We're async if we have a successful pairing request
*retval = 1;
return COMMAND_PENDING;
}
/* Thread: filescanner, mpd */
void
remote_pairing_kickoff(char **arglist)
{
char *cmdarg;
int ret;
ret = strlen(arglist[0]);
if (ret != 4)
{
DPRINTF(E_LOG, L_REMOTE, "Kickoff pairing failed, first line did not contain a 4-digit pin (got %d)\n", ret);
return;
}
cmdarg = strdup(arglist[0]);
DPRINTF(E_LOG, L_REMOTE, "Kickoff pairing with pin '%s'\n", arglist[0]);
commands_exec_async(cmdbase, pairing_pair, cmdarg);
}
int
remote_pairing_pair(const char *pin)
{
char cmdarg[5];
int ret;
ret = strlen(pin);
if (ret != 4)
{
DPRINTF(E_LOG, L_REMOTE, "Pairing failed, not a 4-digit pin (got %d)\n", ret);
return REMOTE_INVALID_PIN;
}
snprintf(cmdarg, sizeof(cmdarg), "%s", pin);
return commands_exec_sync(cmdbase, pairing_pair, NULL, &cmdarg);
}
/* Thread: main */
int
remote_pairing_init(void)
{
int ret;
remote_info = NULL;
CHECK_ERR(L_REMOTE, mutex_init(&remote_lck));
cmdbase = commands_base_new(evbase_main, NULL);
// No ipv6 for remote at the moment
ret = mdns_browse("_touch-remote._tcp", touch_remote_cb, MDNS_IPV4ONLY);
if (ret < 0)
{
DPRINTF(E_FATAL, L_REMOTE, "Could not browse for Remote services\n");
goto mdns_browse_fail;
}
return 0;
mdns_browse_fail:
commands_base_free(cmdbase);
return -1;
}
/* Thread: main */
void
remote_pairing_deinit(void)
{
if (remote_info)
free_remote(remote_info);
commands_base_free(cmdbase);
CHECK_ERR(L_REMOTE, pthread_mutex_destroy(&remote_lck));
}