HS 2.0: Add a command to retrieve icon with in-memory storage

This adds a new command based Hotspot 2.0 icon retrieval option.

In short, here is the new command sequence:
1. REQ_HS20_ICON <bssid> <file-name>
2. event: RX-HS20-ICON <bssid> <file-name> <size>
3. GET_HS20_ICON <bssid> <file-name> <offset> <size>
   (if needed, repeat with larger offset values until full icon is
   fetched)
5. DEL_HS20_ICON <bssid> <file-name>

REQ_HS20_ICON is a new command that is analogous to HS20_ICON_REQUEST
with the slight difference that an entry to store the icon in memory is
prepared. The RX-HS20-ICON event has been augmented with BSSID,
file-name and size, and GET_HS20_ICON is used to retrieve a chunk of up
to <size> bytes of icon data at offset <offset>. Each chunk is returned
as a base64 encoded fragment, preceded by "HS20-ICON-DATA", BSSID, and
file-name as well as the starting offset of the data.

If there is no entry prepared for the icon when the ANQP result comes
back, hs20_process_icon_binary_file falls back to legacy behavior.

Finally the DEL_HS20_ICON command deletes (all) icons associated with
BSSID and file-name (there could be several if retries are used and they
have different dialog tokens).

Signed-off-by: Jan Nordqvist <jannq@google.com>
This commit is contained in:
Jan Nordqvist 2015-12-10 17:01:46 -08:00 committed by Jouni Malinen
parent 2e99239bd9
commit 8dd5c1b4e9
5 changed files with 241 additions and 17 deletions

View file

@ -6450,7 +6450,7 @@ static int get_hs20_anqp(struct wpa_supplicant *wpa_s, char *dst)
if (subtypes == 0)
return -1;
return hs20_anqp_send_req(wpa_s, dst_addr, subtypes, NULL, 0);
return hs20_anqp_send_req(wpa_s, dst_addr, subtypes, NULL, 0, 0);
}
@ -6473,7 +6473,7 @@ static int hs20_nai_home_realm_list(struct wpa_supplicant *wpa_s,
ret = hs20_anqp_send_req(wpa_s, addr,
BIT(HS20_STYPE_NAI_HOME_REALM_QUERY),
buf, len);
buf, len, 0);
os_free(buf);
@ -6519,14 +6519,59 @@ static int hs20_get_nai_home_realm_list(struct wpa_supplicant *wpa_s,
ret = hs20_anqp_send_req(wpa_s, dst_addr,
BIT(HS20_STYPE_NAI_HOME_REALM_QUERY),
buf, len);
buf, len, 0);
os_free(buf);
return ret;
}
static int hs20_icon_request(struct wpa_supplicant *wpa_s, char *cmd)
static int get_hs20_icon(struct wpa_supplicant *wpa_s, char *cmd, char *reply,
int buflen)
{
u8 dst_addr[ETH_ALEN];
int used;
char *ctx = NULL, *icon, *poffset, *psize;
used = hwaddr_aton2(cmd, dst_addr);
if (used < 0)
return -1;
cmd += used;
icon = str_token(cmd, " ", &ctx);
poffset = str_token(cmd, " ", &ctx);
psize = str_token(cmd, " ", &ctx);
if (!icon || !poffset || !psize)
return -1;
wpa_s->fetch_osu_icon_in_progress = 0;
return hs20_get_icon(wpa_s, dst_addr, icon, atoi(poffset), atoi(psize),
reply, buflen);
}
static int del_hs20_icon(struct wpa_supplicant *wpa_s, char *cmd)
{
u8 dst_addr[ETH_ALEN];
int used;
char *icon;
if (!cmd[0])
return hs20_del_icon(wpa_s, NULL, NULL);
used = hwaddr_aton2(cmd, dst_addr);
if (used < 0)
return -1;
while (cmd[used] == ' ')
used++;
icon = cmd[used] ? &cmd[used] : NULL;
return hs20_del_icon(wpa_s, dst_addr, icon);
}
static int hs20_icon_request(struct wpa_supplicant *wpa_s, char *cmd, int inmem)
{
u8 dst_addr[ETH_ALEN];
int used;
@ -6542,7 +6587,7 @@ static int hs20_icon_request(struct wpa_supplicant *wpa_s, char *cmd)
wpa_s->fetch_osu_icon_in_progress = 0;
return hs20_anqp_send_req(wpa_s, dst_addr, BIT(HS20_STYPE_ICON_REQUEST),
(u8 *) icon, os_strlen(icon));
(u8 *) icon, os_strlen(icon), inmem);
}
#endif /* CONFIG_HS20 */
@ -6965,6 +7010,7 @@ static void wpa_supplicant_ctrl_iface_flush(struct wpa_supplicant *wpa_s)
#ifdef CONFIG_INTERWORKING
#ifdef CONFIG_HS20
hs20_cancel_fetch_osu(wpa_s);
hs20_del_icon(wpa_s, NULL, NULL);
#endif /* CONFIG_HS20 */
#endif /* CONFIG_INTERWORKING */
@ -8588,7 +8634,15 @@ char * wpa_supplicant_ctrl_iface_process(struct wpa_supplicant *wpa_s,
if (hs20_get_nai_home_realm_list(wpa_s, buf + 29) < 0)
reply_len = -1;
} else if (os_strncmp(buf, "HS20_ICON_REQUEST ", 18) == 0) {
if (hs20_icon_request(wpa_s, buf + 18) < 0)
if (hs20_icon_request(wpa_s, buf + 18, 0) < 0)
reply_len = -1;
} else if (os_strncmp(buf, "REQ_HS20_ICON ", 14) == 0) {
if (hs20_icon_request(wpa_s, buf + 14, 1) < 0)
reply_len = -1;
} else if (os_strncmp(buf, "GET_HS20_ICON ", 14) == 0) {
reply_len = get_hs20_icon(wpa_s, buf + 14, reply, reply_size);
} else if (os_strncmp(buf, "DEL_HS20_ICON ", 14) == 0) {
if (del_hs20_icon(wpa_s, buf + 14) < 0)
reply_len = -1;
} else if (os_strcmp(buf, "FETCH_OSU") == 0) {
if (hs20_fetch_osu(wpa_s) < 0)

View file

@ -25,6 +25,7 @@
#include "gas_query.h"
#include "interworking.h"
#include "hs20_supplicant.h"
#include "base64.h"
#define OSU_MAX_ITEMS 10
@ -180,13 +181,15 @@ struct wpabuf * hs20_build_anqp_req(u32 stypes, const u8 *payload,
int hs20_anqp_send_req(struct wpa_supplicant *wpa_s, const u8 *dst, u32 stypes,
const u8 *payload, size_t payload_len)
const u8 *payload, size_t payload_len, int inmem)
{
struct wpabuf *buf;
int ret = 0;
int freq;
struct wpa_bss *bss;
int res;
struct icon_entry *icon_entry;
struct icon_entry *picon_entry;
bss = wpa_bss_get_bssid(wpa_s, dst);
if (!bss) {
@ -210,15 +213,145 @@ int hs20_anqp_send_req(struct wpa_supplicant *wpa_s, const u8 *dst, u32 stypes,
if (res < 0) {
wpa_printf(MSG_DEBUG, "ANQP: Failed to send Query Request");
wpabuf_free(buf);
ret = -1;
return -1;
} else
wpa_printf(MSG_DEBUG, "ANQP: Query started with dialog token "
"%u", res);
if (inmem) {
icon_entry = os_zalloc(sizeof(struct icon_entry));
if (!icon_entry)
return -1;
os_memcpy(icon_entry->bssid, dst, ETH_ALEN);
icon_entry->file_name = os_malloc(payload_len + 1);
if (!icon_entry->file_name) {
os_free(icon_entry);
return -1;
}
os_memcpy(icon_entry->file_name, payload, payload_len);
icon_entry->file_name[payload_len] = '\0';
icon_entry->dialog_token = res;
if (wpa_s->icon_head == NULL) {
wpa_s->icon_head = icon_entry;
} else {
picon_entry = wpa_s->icon_head;
while (picon_entry->next)
picon_entry = picon_entry->next;
picon_entry->next = icon_entry;
}
}
return ret;
}
static struct icon_entry * hs20_find_icon(struct wpa_supplicant *wpa_s,
const u8 *bssid,
const char *file_name)
{
struct icon_entry *icon;
for (icon = wpa_s->icon_head; icon; icon = icon->next) {
if (os_memcmp(icon->bssid, bssid, ETH_ALEN) == 0 &&
os_strcmp(icon->file_name, file_name) == 0 && icon->image)
return icon;
}
return NULL;
}
int hs20_get_icon(struct wpa_supplicant *wpa_s, const u8 *bssid,
const char *file_name, size_t offset, size_t size,
char *reply, size_t buf_len)
{
struct icon_entry *icon;
size_t out_size;
unsigned char *b64;
size_t b64_size;
int reply_size;
wpa_printf(MSG_DEBUG, "HS20: Get icon " MACSTR " %s @ %u +%u (%u)",
MAC2STR(bssid), file_name, (unsigned int) offset,
(unsigned int) size, (unsigned int) buf_len);
if (!wpa_s->icon_head)
return -1;
icon = hs20_find_icon(wpa_s, bssid, file_name);
if (!icon || !icon->image || offset >= icon->image_len)
return -1;
if (size > icon->image_len - offset)
size = icon->image_len - offset;
out_size = buf_len - 3 /* max base64 padding */;
if (size * 4 > out_size * 3)
size = out_size * 3 / 4;
if (size == 0)
return -1;
b64 = base64_encode(&icon->image[offset], size, &b64_size);
if (buf_len >= b64_size) {
os_memcpy(reply, b64, b64_size);
reply_size = b64_size;
} else {
reply_size = -1;
}
os_free(b64);
return reply_size;
}
static void hs20_free_icon_entry(struct icon_entry *icon)
{
wpa_printf(MSG_DEBUG, "HS20: Free stored icon from " MACSTR
" dialog_token=%u file_name=%s image_len=%u",
MAC2STR(icon->bssid), icon->dialog_token,
icon->file_name ? icon->file_name : "N/A",
(unsigned int) icon->image_len);
os_free(icon->file_name);
os_free(icon->image);
os_free(icon);
}
int hs20_del_icon(struct wpa_supplicant *wpa_s, const u8 *bssid,
const char *file_name)
{
struct icon_entry **picon_entry;
struct icon_entry *icon_entry;
int count = 0;
if (!bssid)
wpa_printf(MSG_DEBUG, "HS20: Delete all stored icons");
else if (!file_name)
wpa_printf(MSG_DEBUG, "HS20: Delete all stored icons for "
MACSTR, MAC2STR(bssid));
else
wpa_printf(MSG_DEBUG, "HS20: Delete stored icons for "
MACSTR " file name %s", MAC2STR(bssid), file_name);
picon_entry = &wpa_s->icon_head;
while (*picon_entry) {
if ((!bssid ||
os_memcmp((*picon_entry)->bssid, bssid, ETH_ALEN) == 0) &&
(!file_name ||
os_strcmp((*picon_entry)->file_name, file_name) == 0)) {
icon_entry = *picon_entry;
*picon_entry = icon_entry->next;
hs20_free_icon_entry(icon_entry);
count++;
continue;
}
if (*picon_entry == NULL)
break;
picon_entry = &(*picon_entry)->next;
}
return count == 0 ? -1 : 0;
}
static void hs20_set_osu_access_permission(const char *osu_dir,
const char *fname)
{
@ -245,12 +378,29 @@ static void hs20_set_osu_access_permission(const char *osu_dir,
static int hs20_process_icon_binary_file(struct wpa_supplicant *wpa_s,
const u8 *sa, const u8 *pos,
size_t slen)
size_t slen, u8 dialog_token)
{
char fname[256];
int png;
FILE *f;
u16 data_len;
struct icon_entry *icon;
for (icon = wpa_s->icon_head; icon; icon = icon->next) {
if (icon->dialog_token == dialog_token && !icon->image &&
os_memcmp(icon->bssid, sa, ETH_ALEN) == 0) {
icon->image = os_malloc(slen);
if (!icon->image)
return -1;
os_memcpy(icon->image, pos, slen);
icon->image_len = slen;
wpa_msg(wpa_s, MSG_INFO,
"RX-HS20-ICON " MACSTR " %s %u",
MAC2STR(sa), icon->file_name,
(unsigned int) icon->image_len);
return 0;
}
}
wpa_msg(wpa_s, MSG_INFO, "RX-HS20-ANQP " MACSTR " Icon Binary File",
MAC2STR(sa));
@ -358,7 +508,7 @@ static void hs20_osu_icon_fetch_result(struct wpa_supplicant *wpa_s, int res)
void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant *wpa_s,
struct wpa_bss *bss, const u8 *sa,
const u8 *data, size_t slen)
const u8 *data, size_t slen, u8 dialog_token)
{
const u8 *pos = data;
u8 subtype;
@ -445,7 +595,8 @@ void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant *wpa_s,
}
break;
case HS20_STYPE_ICON_BINARY_FILE:
ret = hs20_process_icon_binary_file(wpa_s, sa, pos, slen);
ret = hs20_process_icon_binary_file(wpa_s, sa, pos, slen,
dialog_token);
if (wpa_s->fetch_osu_icon_in_progress) {
hs20_osu_icon_fetch_result(wpa_s, ret);
eloop_cancel_timeout(hs20_continue_icon_fetch,
@ -579,7 +730,8 @@ void hs20_next_osu_icon(struct wpa_supplicant *wpa_s)
if (hs20_anqp_send_req(wpa_s, osu->bssid,
BIT(HS20_STYPE_ICON_REQUEST),
(u8 *) icon->filename,
os_strlen(icon->filename)) < 0) {
os_strlen(icon->filename),
0) < 0) {
icon->failed = 1;
continue;
}
@ -1006,4 +1158,5 @@ void hs20_deinit(struct wpa_supplicant *wpa_s)
{
eloop_cancel_timeout(hs20_continue_icon_fetch, wpa_s, NULL);
hs20_free_osu_prov(wpa_s);
hs20_del_icon(wpa_s, NULL, NULL);
}

View file

@ -11,14 +11,14 @@
void wpas_hs20_add_indication(struct wpabuf *buf, int pps_mo_id);
int hs20_anqp_send_req(struct wpa_supplicant *wpa_s, const u8 *dst, u32 stypes,
const u8 *payload, size_t payload_len);
const u8 *payload, size_t payload_len, int inmem);
struct wpabuf * hs20_build_anqp_req(u32 stypes, const u8 *payload,
size_t payload_len);
void hs20_put_anqp_req(u32 stypes, const u8 *payload, size_t payload_len,
struct wpabuf *buf);
void hs20_parse_rx_hs20_anqp_resp(struct wpa_supplicant *wpa_s,
struct wpa_bss *bss, const u8 *sa,
const u8 *data, size_t slen);
const u8 *data, size_t slen, u8 dialog_token);
int is_hs20_network(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
struct wpa_bss *bss);
int hs20_get_pps_mo_id(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
@ -37,5 +37,10 @@ void hs20_cancel_fetch_osu(struct wpa_supplicant *wpa_s);
void hs20_icon_fetch_failed(struct wpa_supplicant *wpa_s);
void hs20_start_osu_scan(struct wpa_supplicant *wpa_s);
void hs20_deinit(struct wpa_supplicant *wpa_s);
int hs20_get_icon(struct wpa_supplicant *wpa_s, const u8 *bssid,
const char *file_name, size_t offset, size_t size,
char *reply, size_t buf_len);
int hs20_del_icon(struct wpa_supplicant *wpa_s, const u8 *bssid,
const char *file_name);
#endif /* HS20_SUPPLICANT_H */

View file

@ -2775,7 +2775,8 @@ static void anqp_add_extra(struct wpa_supplicant *wpa_s,
static void interworking_parse_rx_anqp_resp(struct wpa_supplicant *wpa_s,
struct wpa_bss *bss, const u8 *sa,
u16 info_id,
const u8 *data, size_t slen)
const u8 *data, size_t slen,
u8 dialog_token)
{
const u8 *pos = data;
struct wpa_bss_anqp *anqp = NULL;
@ -2885,7 +2886,8 @@ static void interworking_parse_rx_anqp_resp(struct wpa_supplicant *wpa_s,
switch (type) {
case HS20_ANQP_OUI_TYPE:
hs20_parse_rx_hs20_anqp_resp(wpa_s, bss, sa,
pos, slen);
pos, slen,
dialog_token);
break;
default:
wpa_msg(wpa_s, MSG_DEBUG,
@ -2988,7 +2990,7 @@ void anqp_resp_cb(void *ctx, const u8 *dst, u8 dialog_token,
goto out_parse_done;
}
interworking_parse_rx_anqp_resp(wpa_s, bss, dst, info_id, pos,
slen);
slen, dialog_token);
pos += slen;
}

View file

@ -425,6 +425,15 @@ enum wpa_supplicant_test_failure {
WPAS_TEST_FAILURE_SCAN_TRIGGER,
};
struct icon_entry {
struct icon_entry *next;
u8 bssid[ETH_ALEN];
u8 dialog_token;
char *file_name;
u8 *image;
size_t image_len;
};
/**
* struct wpa_supplicant - Internal data for wpa_supplicant interface
*
@ -905,6 +914,7 @@ struct wpa_supplicant {
unsigned int fetch_osu_icon_in_progress:1;
struct wpa_bss *interworking_gas_bss;
unsigned int osu_icon_id;
struct icon_entry *icon_head;
struct osu_provider *osu_prov;
size_t osu_prov_count;
struct os_reltime osu_icon_fetch_start;