auth.h
Go to the documentation of this file.
#pragma once
#include <stdint.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/utils.h>
#define OSMO_A5_MAX_KEY_LEN_BYTES (128/8)
#define OSMO_MILENAGE_IND_BITLEN_MAX 28
enum osmo_sub_auth_type {
OSMO_AUTH_TYPE_NONE = 0x00,
OSMO_AUTH_TYPE_GSM = 0x01,
OSMO_AUTH_TYPE_UMTS = 0x02,
};
extern const struct value_string osmo_sub_auth_type_names[];
static inline const char *osmo_sub_auth_type_name(enum osmo_sub_auth_type val)
{ return get_value_string(osmo_sub_auth_type_names, val); }
enum osmo_auth_algo {
OSMO_AUTH_ALG_NONE,
OSMO_AUTH_ALG_COMP128v1,
OSMO_AUTH_ALG_COMP128v2,
OSMO_AUTH_ALG_COMP128v3,
OSMO_AUTH_ALG_XOR,
OSMO_AUTH_ALG_MILENAGE,
_OSMO_AUTH_ALG_NUM,
};
struct osmo_sub_auth_data {
enum osmo_sub_auth_type type;
enum osmo_auth_algo algo;
union {
struct {
uint8_t opc[16];
uint8_t k[OSMO_A5_MAX_KEY_LEN_BYTES];
uint8_t amf[2];
uint64_t sqn;
int opc_is_op;
unsigned int ind_bitlen;
unsigned int ind;
uint64_t sqn_ms;
} umts;
struct {
uint8_t ki[OSMO_A5_MAX_KEY_LEN_BYTES];
} gsm;
} u;
};
/* data structure describing a computed auth vector, generated by AuC */
struct osmo_auth_vector {
uint8_t rand[16];
uint8_t autn[16];
uint8_t ck[OSMO_A5_MAX_KEY_LEN_BYTES];
uint8_t ik[OSMO_A5_MAX_KEY_LEN_BYTES];
uint8_t res[16];
uint8_t res_len;
uint8_t kc[8];
uint8_t sres[4];
uint32_t auth_types;
};
/* An implementation of an authentication algorithm */
struct osmo_auth_impl {
struct llist_head list;
enum osmo_auth_algo algo;
const char *name;
unsigned int priority;
int (*gen_vec)(struct osmo_auth_vector *vec,
struct osmo_sub_auth_data *aud,
const uint8_t *_rand);
/* callback for generationg auth vectors + re-sync */
int (*gen_vec_auts)(struct osmo_auth_vector *vec,
struct osmo_sub_auth_data *aud,
const uint8_t *auts, const uint8_t *rand_auts,
const uint8_t *_rand);
};
int osmo_auth_gen_vec(struct osmo_auth_vector *vec,
struct osmo_sub_auth_data *aud, const uint8_t *_rand);
int osmo_auth_gen_vec_auts(struct osmo_auth_vector *vec,
struct osmo_sub_auth_data *aud,
const uint8_t *auts, const uint8_t *rand_auts,
const uint8_t *_rand);
int osmo_auth_register(struct osmo_auth_impl *impl);
int osmo_auth_load(const char *path);
int osmo_auth_supported(enum osmo_auth_algo algo);
void osmo_c4(uint8_t *ck, const uint8_t *kc);
const char *osmo_auth_alg_name(enum osmo_auth_algo alg);
enum osmo_auth_algo osmo_auth_alg_parse(const char *name);
void osmo_auth_c3(uint8_t kc[], const uint8_t ck[], const uint8_t ik[]);
/* @} */
osmo_auth_impl::algo
enum osmo_auth_algo algo
algorithm we implement
Definition: auth.h:75
osmo_auth_register
int osmo_auth_register(struct osmo_auth_impl *impl)
Register an authentication algorithm implementation with the core.
Definition: auth_core.c:52
osmo_auth_supported
int osmo_auth_supported(enum osmo_auth_algo algo)
Determine if a given authentication algorithm is supported.
Definition: auth_core.c:90
osmo_auth_impl::list
struct llist_head list
Definition: auth.h:74
osmo_auth_gen_vec
int osmo_auth_gen_vec(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *_rand)
Generate authentication vector.
Definition: auth_core.c:156
osmo_sub_auth_data::gsm
struct osmo_sub_auth_data::@105::@107 gsm
osmo_sub_auth_data::amf
uint8_t amf[2]
Definition: auth.h:46
osmo_sub_auth_data::u
union osmo_sub_auth_data::@105 u
osmo_auth_alg_parse
enum osmo_auth_algo osmo_auth_alg_parse(const char *name)
Parse human-readable name of authentication algorithm.
Definition: auth_core.c:227
osmo_auth_c3
void osmo_auth_c3(uint8_t kc[], const uint8_t ck[], const uint8_t ik[])
Definition: auth_core.c:245
osmo_auth_impl::priority
unsigned int priority
priority value (resp.
Definition: auth.h:77
osmo_sub_auth_data::opc
uint8_t opc[16]
operator invariant value
Definition: auth.h:44
osmo_auth_algo
osmo_auth_algo
Authentication Algorithm.
Definition: auth.h:28
osmo_sub_auth_type_name
static const char * osmo_sub_auth_type_name(enum osmo_sub_auth_type val)
Definition: auth.h:23
osmo_sub_auth_data::ind
unsigned int ind
which IND slot to use an SQN from
Definition: auth.h:50
osmo_auth_vector::kc
uint8_t kc[8]
Kc for GSM encryption (A5)
Definition: auth.h:67
osmo_sub_auth_data::opc_is_op
int opc_is_op
is the OPC field OPC (0) or OP (1) ?
Definition: auth.h:48
osmo_auth_load
int osmo_auth_load(const char *path)
Load all available authentication plugins from the given path.
Definition: auth_core.c:73
osmo_sub_auth_data::sqn
uint64_t sqn
sequence number (in: prev sqn; out: used sqn)
Definition: auth.h:47
osmo_sub_auth_data::type
enum osmo_sub_auth_type type
Definition: auth.h:40
OSMO_A5_MAX_KEY_LEN_BYTES
#define OSMO_A5_MAX_KEY_LEN_BYTES
Definition: auth.h:12
osmo_auth_impl::name
const char * name
name of the implementation
Definition: auth.h:76
osmo_sub_auth_type_names
const struct value_string osmo_sub_auth_type_names[]
Definition: auth_core.c:232
osmo_auth_impl::gen_vec
int(* gen_vec)(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *_rand)
callback for generate authentication vectors
Definition: auth.h:80
osmo_auth_alg_name
const char * osmo_auth_alg_name(enum osmo_auth_algo alg)
Get human-readable name of authentication algorithm.
Definition: auth_core.c:221
osmo_auth_vector::sres
uint8_t sres[4]
authentication result for GSM
Definition: auth.h:68
osmo_auth_vector::res
uint8_t res[16]
authentication result
Definition: auth.h:65
osmo_c4
void osmo_c4(uint8_t *ck, const uint8_t *kc)
Definition: auth_core.c:114
osmo_sub_auth_data::umts
struct osmo_sub_auth_data::@105::@106 umts
osmo_sub_auth_type
osmo_sub_auth_type
Authentication Type (GSM/UMTS)
Definition: auth.h:16
osmo_auth_gen_vec_auts
int osmo_auth_gen_vec_auts(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *auts, const uint8_t *rand_auts, const uint8_t *_rand)
Generate authentication vector and re-sync sequence.
Definition: auth_core.c:190
osmo_auth_vector::ik
uint8_t ik[OSMO_A5_MAX_KEY_LEN_BYTES]
integrity key
Definition: auth.h:64
osmo_auth_vector::res_len
uint8_t res_len
length (in bytes) of res
Definition: auth.h:66
osmo_sub_auth_data::ki
uint8_t ki[OSMO_A5_MAX_KEY_LEN_BYTES]
secret key
Definition: auth.h:54
osmo_sub_auth_data::sqn_ms
uint64_t sqn_ms
sqn from AUTS (output value only)
Definition: auth.h:51
osmo_auth_impl::gen_vec_auts
int(* gen_vec_auts)(struct osmo_auth_vector *vec, struct osmo_sub_auth_data *aud, const uint8_t *auts, const uint8_t *rand_auts, const uint8_t *_rand)
Definition: auth.h:85
osmo_sub_auth_data::k
uint8_t k[OSMO_A5_MAX_KEY_LEN_BYTES]
secret key of the subscriber
Definition: auth.h:45
osmo_auth_vector::rand
uint8_t rand[16]
random challenge
Definition: auth.h:61
osmo_sub_auth_data::ind_bitlen
unsigned int ind_bitlen
nr of bits not in SEQ, only SQN
Definition: auth.h:49
osmo_auth_vector::auth_types
uint32_t auth_types
bitmask of OSMO_AUTH_TYPE_*
Definition: auth.h:69
osmo_auth_vector::ck
uint8_t ck[OSMO_A5_MAX_KEY_LEN_BYTES]
ciphering key
Definition: auth.h:63
osmo_sub_auth_data::algo
enum osmo_auth_algo algo
Definition: auth.h:41
osmo_auth_vector::autn
uint8_t autn[16]
authentication nonce
Definition: auth.h:62
OSMO_AUTH_ALG_XOR
@ OSMO_AUTH_ALG_XOR
Definition: auth.h:33
OSMO_AUTH_ALG_COMP128v2
@ OSMO_AUTH_ALG_COMP128v2
Definition: auth.h:31
OSMO_AUTH_ALG_NONE
@ OSMO_AUTH_ALG_NONE
Definition: auth.h:29
OSMO_AUTH_ALG_COMP128v1
@ OSMO_AUTH_ALG_COMP128v1
Definition: auth.h:30
OSMO_AUTH_ALG_COMP128v3
@ OSMO_AUTH_ALG_COMP128v3
Definition: auth.h:32
_OSMO_AUTH_ALG_NUM
@ _OSMO_AUTH_ALG_NUM
Definition: auth.h:35
OSMO_AUTH_ALG_MILENAGE
@ OSMO_AUTH_ALG_MILENAGE
Definition: auth.h:34
OSMO_AUTH_TYPE_UMTS
@ OSMO_AUTH_TYPE_UMTS
Definition: auth.h:19
OSMO_AUTH_TYPE_GSM
@ OSMO_AUTH_TYPE_GSM
Definition: auth.h:18
OSMO_AUTH_TYPE_NONE
@ OSMO_AUTH_TYPE_NONE
Definition: auth.h:17
get_value_string
const char * get_value_string(const struct value_string *vs, uint32_t val)
linuxlist.h
llist_head
osmo_auth_impl
Definition: auth.h:73
osmo_auth_vector
Definition: auth.h:60
osmo_sub_auth_data
permanent (secret) subscriber auth data
Definition: auth.h:39
value_string
utils.h