Merged SIM/USIM manager/card/provider, avoids code duplication

This commit is contained in:
Martin Willi
2009-10-12 14:40:21 +02:00
parent f7897b64f6
commit 073e7dc062
16 changed files with 129 additions and 340 deletions
+82 -7
View File
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2008 Martin Willi
* Copyright (C) 2008-2009 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
@@ -32,13 +32,25 @@ typedef struct sim_provider_t sim_provider_t;
#define SIM_SRES_LEN 4
#define SIM_KC_LEN 8
#define AKA_RAND_LEN 16
#define AKA_RES_LEN 16
#define AKA_CK_LEN 16
#define AKA_IK_LEN 16
#define AKA_AUTN_LEN 16
#define AKA_AUTS_LEN 14
/**
* Interface for a SIM card (used as EAP client).
* Interface for a (U)SIM card (used as EAP client).
*
* The SIM card completes triplets/quintuplets requested in a challenge
* received from the server.
* An implementation supporting only one of SIM/AKA authentication may
* implement the other methods with return_false()/return NOT_SUPPORTED.
*/
struct sim_card_t {
/**
* Calculate SRES/KC from a RAND.
* Calculate SRES/KC from a RAND for SIM authentication.
*
* @param imsi identity to get a triplet for
* @param rand RAND input buffer, fixed size 16 bytes
@@ -49,15 +61,51 @@ struct sim_card_t {
bool (*get_triplet)(sim_card_t *this, identification_t *imsi,
char rand[SIM_RAND_LEN], char sres[SIM_SRES_LEN],
char kc[SIM_KC_LEN]);
/**
* Calculate CK/IK/RES from RAND/AUTN for AKA authentication.
*
* If the received sequence number (in autn) is out of sync, INVALID_STATE
* is returned.
*
* @param imsi peer identity requesting quintuplet for
* @param rand random value rand
* @param autn authentication token autn
* @param ck buffer receiving encryption key ck
* @param ik buffer receiving integrity key ik
* @param res buffer receiving authentication result res
* @return SUCCESS, FAILED, or INVALID_STATE if out of sync
*/
status_t (*get_quintuplet)(sim_card_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char autn[AKA_AUTN_LEN],
char ck[AKA_CK_LEN], char ik[AKA_IK_LEN],
char res[AKA_RES_LEN]);
/**
* Calculate AUTS from RAND for AKA resynchronization.
*
* @param imsi peer identity requesting quintuplet for
* @param rand random value rand
* @param auts resynchronization parameter auts
* @return TRUE if parameter generated successfully
*/
bool (*resync)(sim_card_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char auts[AKA_AUTS_LEN]);
};
/**
* Interface for a triplet provider (used as EAP server).
* Interface for a triplet/quintuplet provider (used as EAP server).
*
* A SIM provider hands out triplets for SIM authentication and quintuplets
* for AKA authentication. Multiple SIM provider instances can serve as
* authentication backend to authenticate clients using SIM/AKA.
* An implementation supporting only one of SIM/AKA authentication may
* implement the other methods with return_false().
*/
struct sim_provider_t {
/**
* Get a single triplet to authenticate a EAP client.
* Create a challenge for SIM authentication.
*
* @param imsi client identity
* @param rand RAND output buffer, fixed size 16 bytes
@@ -68,10 +116,37 @@ struct sim_provider_t {
bool (*get_triplet)(sim_provider_t *this, identification_t *imsi,
char rand[SIM_RAND_LEN], char sres[SIM_SRES_LEN],
char kc[SIM_KC_LEN]);
/**
* Create a challenge for AKA authentication.
*
* @param imsi peer identity to create challenge for
* @param rand buffer receiving random value rand
* @param xres buffer receiving expected authentication result xres
* @param ck buffer receiving encryption key ck
* @param ik buffer receiving integrity key ik
* @param autn authentication token autn
* @return TRUE if quintuplet generated successfully
*/
bool (*get_quintuplet)(sim_provider_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char xres[AKA_RES_LEN],
char ck[AKA_CK_LEN], char ik[AKA_IK_LEN],
char autn[AKA_AUTN_LEN]);
/**
* Process AKA resynchroniusation request of a peer.
*
* @param imsi peer identity requesting resynchronisation
* @param rand random value rand
* @param auts synchronization parameter auts
* @return TRUE if resynchronized successfully
*/
bool (*resync)(sim_provider_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char auts[AKA_AUTS_LEN]);
};
/**
* The EAP-SIM manager handles multiple SIM cards and providers.
* The SIM manager handles multiple (U)SIM cards and providers.
*/
struct sim_manager_t {
@@ -124,7 +199,7 @@ struct sim_manager_t {
};
/**
* Create an SIM manager to handle multiple SIM cards/providers.
* Create an SIM manager to handle multiple (U)SIM cards/providers.
*
* @return sim_t object
*/
@@ -1,123 +0,0 @@
/*
* Copyright (C) 2008-2009 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* 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. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* 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.
*/
#include "usim_manager.h"
#include <utils/linked_list.h>
typedef struct private_usim_manager_t private_usim_manager_t;
/**
* Private data of an usim_manager_t object.
*/
struct private_usim_manager_t {
/**
* Public usim_manager_t interface.
*/
usim_manager_t public;
/**
* list of added cards
*/
linked_list_t *cards;
/**
* list of added provider
*/
linked_list_t *provider;
};
/**
* Implementation of usim_manager_t.add_card
*/
static void add_card(private_usim_manager_t *this, usim_card_t *card)
{
this->cards->insert_last(this->cards, card);
}
/**
* Implementation of usim_manager_t.remove_card
*/
static void remove_card(private_usim_manager_t *this, usim_card_t *card)
{
this->cards->remove(this->cards, card, NULL);
}
/**
* Implementation of usim_manager_t.create_card_enumerator
*/
static enumerator_t* create_card_enumerator(private_usim_manager_t *this)
{
return this->cards->create_enumerator(this->cards);
}
/**
* Implementation of usim_manager_t.add_provider
*/
static void add_provider(private_usim_manager_t *this,
usim_provider_t *provider)
{
this->provider->insert_last(this->provider, provider);
}
/**
* Implementation of usim_manager_t.remove_provider
*/
static void remove_provider(private_usim_manager_t *this,
usim_provider_t *provider)
{
this->provider->remove(this->provider, provider, NULL);
}
/**
* Implementation of usim_manager_t.create_provider_enumerator
*/
static enumerator_t* create_provider_enumerator(private_usim_manager_t *this)
{
return this->provider->create_enumerator(this->provider);
}
/**
* Implementation of usim_manager_t.destroy.
*/
static void destroy(private_usim_manager_t *this)
{
this->cards->destroy(this->cards);
this->provider->destroy(this->provider);
free(this);
}
/**
* See header
*/
usim_manager_t *usim_manager_create()
{
private_usim_manager_t *this = malloc_thing(private_usim_manager_t);
this->public.add_card = (void(*)(usim_manager_t*, usim_card_t *card))add_card;
this->public.remove_card = (void(*)(usim_manager_t*, usim_card_t *card))remove_card;
this->public.create_card_enumerator = (enumerator_t*(*)(usim_manager_t*))create_card_enumerator;
this->public.add_provider = (void(*)(usim_manager_t*, usim_provider_t *provider))add_provider;
this->public.remove_provider = (void(*)(usim_manager_t*, usim_provider_t *provider))remove_provider;
this->public.create_provider_enumerator = (enumerator_t*(*)(usim_manager_t*))create_provider_enumerator;
this->public.destroy = (void(*)(usim_manager_t*))destroy;
this->cards = linked_list_create();
this->provider = linked_list_create();
return &this->public;
}
@@ -1,167 +0,0 @@
/*
* Copyright (C) 2008-2009 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* 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. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* 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.
*/
/**
* @defgroup usim_manager usim_manager
* @{ @ingroup eap
*/
#ifndef USIM_MANAGER_H_
#define USIM_MANAGER_H_
#include <utils/identification.h>
#include <utils/enumerator.h>
typedef struct usim_manager_t usim_manager_t;
typedef struct usim_card_t usim_card_t;
typedef struct usim_provider_t usim_provider_t;
#define AKA_RAND_LEN 16
#define AKA_RES_LEN 16
#define AKA_CK_LEN 16
#define AKA_IK_LEN 16
#define AKA_AUTN_LEN 16
#define AKA_AUTS_LEN 14
/**
* Interface for a USIM card (used by EAP-AKA client).
*/
struct usim_provider_t {
/**
* Create a challenge for AKA authentication.
*
* @param imsi peer identity to create challenge for
* @param rand buffer receiving random value rand
* @param xres buffer receiving expected authentication result xres
* @param ck buffer receiving encryption key ck
* @param ik buffer receiving integrity key ik
* @param autn authentication token autn
* @return TRUE if quintuplet generated successfully
*/
bool (*get_quintuplet)(usim_provider_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char xres[AKA_RES_LEN],
char ck[AKA_CK_LEN], char ik[AKA_IK_LEN],
char autn[AKA_AUTN_LEN]);
/**
* Process resynchroniusation request of a peer.
*
* @param imsi peer identity requesting resynchronisation
* @param rand random value rand
* @param auts synchronization parameter auts
* @return TRUE if resynchronized successfully
*/
bool (*resync)(usim_provider_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char auts[AKA_AUTS_LEN]);
};
/**
* Interface for a quintuplet provider (used by EAP-AKA server).
*/
struct usim_card_t {
/**
* Process authentication data and complete the quintuplet.
*
* If the received sequence number (in autn) is out of synf, INVALID_STATE
* is returned.
*
* @param imsi peer identity requesting quintuplet for
* @param rand random value rand
* @param autn authentication token autn
* @param ck buffer receiving encryption key ck
* @param ik buffer receiving integrity key ik
* @param res buffer receiving authentication result res
* @return SUCCESS, FAILED, or INVALID_STATE if out of sync
*/
status_t (*get_quintuplet)(usim_card_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char autn[AKA_AUTN_LEN],
char ck[AKA_CK_LEN], char ik[AKA_IK_LEN],
char res[AKA_RES_LEN]);
/**
* Request parameter to start resynchronization.
*
* @param imsi peer identity requesting quintuplet for
* @param rand random value rand
* @param auts resynchronization parameter auts
* @return TRUE if parameter generated successfully
*/
bool (*resync)(usim_card_t *this, identification_t *imsi,
char rand[AKA_RAND_LEN], char auts[AKA_AUTS_LEN]);
};
/**
* The EAP-AKA USIM manager handles multiple USIM cards and providers.
*/
struct usim_manager_t {
/**
* Register a USIM card (client) at the manager.
*
* @param card usim card to register
*/
void (*add_card)(usim_manager_t *this, usim_card_t *card);
/**
* Unregister a previously registered card from the manager.
*
* @param card usim card to unregister
*/
void (*remove_card)(usim_manager_t *this, usim_card_t *card);
/**
* Create an enumerator over all registered cards.
*
* @return enumerator over usim_card_t's
*/
enumerator_t* (*create_card_enumerator)(usim_manager_t *this);
/**
* Register a triplet provider (server) at the manager.
*
* @param card usim card to register
*/
void (*add_provider)(usim_manager_t *this, usim_provider_t *provider);
/**
* Unregister a previously registered provider from the manager.
*
* @param card usim card to unregister
*/
void (*remove_provider)(usim_manager_t *this, usim_provider_t *provider);
/**
* Create an enumerator over all registered provider.
*
* @return enumerator over Usim_provider_t's
*/
enumerator_t* (*create_provider_enumerator)(usim_manager_t *this);
/**
* Destroy a manager instance.
*/
void (*destroy)(usim_manager_t *this);
};
/**
* Create an USIM manager to handle multiple USIM cards/providers.
*
* @return usim_t object
*/
usim_manager_t *usim_manager_create();
#endif /** USIM_MANAGER_H_ @}*/