xref: /dflybsd-src/contrib/wpa_supplicant/src/eap_server/eap_sim_db.h (revision 3a84a4273475ed07d0ab1c2dfeffdfedef35d9cd)
16d49e1aeSJan Lentfer /*
26d49e1aeSJan Lentfer  * hostapd / EAP-SIM database/authenticator gateway
33ff40c12SJohn Marino  * Copyright (c) 2005-2008, 2012, Jouni Malinen <j@w1.fi>
46d49e1aeSJan Lentfer  *
53ff40c12SJohn Marino  * This software may be distributed under the terms of the BSD license.
63ff40c12SJohn Marino  * See README for more details.
76d49e1aeSJan Lentfer  */
86d49e1aeSJan Lentfer 
96d49e1aeSJan Lentfer #ifndef EAP_SIM_DB_H
106d49e1aeSJan Lentfer #define EAP_SIM_DB_H
116d49e1aeSJan Lentfer 
126d49e1aeSJan Lentfer #include "eap_common/eap_sim_common.h"
136d49e1aeSJan Lentfer 
146d49e1aeSJan Lentfer /* Identity prefixes */
156d49e1aeSJan Lentfer #define EAP_SIM_PERMANENT_PREFIX '1'
166d49e1aeSJan Lentfer #define EAP_SIM_PSEUDONYM_PREFIX '3'
176d49e1aeSJan Lentfer #define EAP_SIM_REAUTH_ID_PREFIX '5'
186d49e1aeSJan Lentfer #define EAP_AKA_PERMANENT_PREFIX '0'
196d49e1aeSJan Lentfer #define EAP_AKA_PSEUDONYM_PREFIX '2'
206d49e1aeSJan Lentfer #define EAP_AKA_REAUTH_ID_PREFIX '4'
213ff40c12SJohn Marino #define EAP_AKA_PRIME_PERMANENT_PREFIX '6'
223ff40c12SJohn Marino #define EAP_AKA_PRIME_PSEUDONYM_PREFIX '7'
233ff40c12SJohn Marino #define EAP_AKA_PRIME_REAUTH_ID_PREFIX '8'
246d49e1aeSJan Lentfer 
253ff40c12SJohn Marino enum eap_sim_db_method {
263ff40c12SJohn Marino 	EAP_SIM_DB_SIM,
273ff40c12SJohn Marino 	EAP_SIM_DB_AKA,
283ff40c12SJohn Marino 	EAP_SIM_DB_AKA_PRIME
293ff40c12SJohn Marino };
303ff40c12SJohn Marino 
313ff40c12SJohn Marino struct eap_sim_db_data;
323ff40c12SJohn Marino 
333ff40c12SJohn Marino struct eap_sim_db_data *
34*a1157835SDaniel Fojt eap_sim_db_init(const char *config, unsigned int db_timeout,
356d49e1aeSJan Lentfer 		void (*get_complete_cb)(void *ctx, void *session_ctx),
366d49e1aeSJan Lentfer 		void *ctx);
376d49e1aeSJan Lentfer 
386d49e1aeSJan Lentfer void eap_sim_db_deinit(void *priv);
396d49e1aeSJan Lentfer 
403ff40c12SJohn Marino int eap_sim_db_get_gsm_triplets(struct eap_sim_db_data *data,
413ff40c12SJohn Marino 				const char *username, int max_chal,
426d49e1aeSJan Lentfer 				u8 *_rand, u8 *kc, u8 *sres,
436d49e1aeSJan Lentfer 				void *cb_session_ctx);
446d49e1aeSJan Lentfer 
456d49e1aeSJan Lentfer #define EAP_SIM_DB_FAILURE -1
466d49e1aeSJan Lentfer #define EAP_SIM_DB_PENDING -2
476d49e1aeSJan Lentfer 
483ff40c12SJohn Marino char * eap_sim_db_get_next_pseudonym(struct eap_sim_db_data *data,
493ff40c12SJohn Marino 				     enum eap_sim_db_method method);
506d49e1aeSJan Lentfer 
513ff40c12SJohn Marino char * eap_sim_db_get_next_reauth_id(struct eap_sim_db_data *data,
523ff40c12SJohn Marino 				     enum eap_sim_db_method method);
536d49e1aeSJan Lentfer 
543ff40c12SJohn Marino int eap_sim_db_add_pseudonym(struct eap_sim_db_data *data,
553ff40c12SJohn Marino 			     const char *permanent, char *pseudonym);
566d49e1aeSJan Lentfer 
573ff40c12SJohn Marino int eap_sim_db_add_reauth(struct eap_sim_db_data *data, const char *permanent,
583ff40c12SJohn Marino 			  char *reauth_id, u16 counter, const u8 *mk);
593ff40c12SJohn Marino int eap_sim_db_add_reauth_prime(struct eap_sim_db_data *data,
603ff40c12SJohn Marino 				const char *permanent,
613ff40c12SJohn Marino 				char *reauth_id, u16 counter, const u8 *k_encr,
623ff40c12SJohn Marino 				const u8 *k_aut, const u8 *k_re);
636d49e1aeSJan Lentfer 
643ff40c12SJohn Marino const char * eap_sim_db_get_permanent(struct eap_sim_db_data *data,
653ff40c12SJohn Marino 				      const char *pseudonym);
666d49e1aeSJan Lentfer 
676d49e1aeSJan Lentfer struct eap_sim_reauth {
686d49e1aeSJan Lentfer 	struct eap_sim_reauth *next;
693ff40c12SJohn Marino 	char *permanent; /* Permanent username */
703ff40c12SJohn Marino 	char *reauth_id; /* Fast re-authentication username */
716d49e1aeSJan Lentfer 	u16 counter;
726d49e1aeSJan Lentfer 	u8 mk[EAP_SIM_MK_LEN];
736d49e1aeSJan Lentfer 	u8 k_encr[EAP_SIM_K_ENCR_LEN];
746d49e1aeSJan Lentfer 	u8 k_aut[EAP_AKA_PRIME_K_AUT_LEN];
756d49e1aeSJan Lentfer 	u8 k_re[EAP_AKA_PRIME_K_RE_LEN];
766d49e1aeSJan Lentfer };
776d49e1aeSJan Lentfer 
786d49e1aeSJan Lentfer struct eap_sim_reauth *
793ff40c12SJohn Marino eap_sim_db_get_reauth_entry(struct eap_sim_db_data *data,
803ff40c12SJohn Marino 			    const char *reauth_id);
816d49e1aeSJan Lentfer 
823ff40c12SJohn Marino void eap_sim_db_remove_reauth(struct eap_sim_db_data *data,
833ff40c12SJohn Marino 			      struct eap_sim_reauth *reauth);
846d49e1aeSJan Lentfer 
853ff40c12SJohn Marino int eap_sim_db_get_aka_auth(struct eap_sim_db_data *data, const char *username,
863ff40c12SJohn Marino 			    u8 *_rand, u8 *autn, u8 *ik, u8 *ck,
873ff40c12SJohn Marino 			    u8 *res, size_t *res_len, void *cb_session_ctx);
886d49e1aeSJan Lentfer 
893ff40c12SJohn Marino int eap_sim_db_resynchronize(struct eap_sim_db_data *data,
903ff40c12SJohn Marino 			     const char *username, const u8 *auts,
916d49e1aeSJan Lentfer 			     const u8 *_rand);
926d49e1aeSJan Lentfer 
933ff40c12SJohn Marino char * sim_get_username(const u8 *identity, size_t identity_len);
946d49e1aeSJan Lentfer 
956d49e1aeSJan Lentfer #endif /* EAP_SIM_DB_H */
96