libosmogsm  0.10.2.279.178b
Osmocom GSM library
auth.h
Go to the documentation of this file.
1 #pragma once
2 
7 #include <stdint.h>
8 
10 #include <osmocom/core/utils.h>
11 
12 #define OSMO_A5_MAX_KEY_LEN_BYTES (128/8)
13 #define OSMO_MILENAGE_IND_BITLEN_MAX 28
14 
20 };
21 
22 extern const struct value_string osmo_sub_auth_type_names[];
23 static inline const char *osmo_sub_auth_type_name(enum osmo_sub_auth_type val)
25 
36 };
37 
42  union {
43  struct {
44  uint8_t opc[16];
45  uint8_t k[16];
46  uint8_t amf[2];
47  uint64_t sqn;
48  int opc_is_op;
49  unsigned int ind_bitlen;
50  unsigned int ind;
51  uint64_t sqn_ms;
52  } umts;
53  struct {
55  } gsm;
56  } u;
57 };
58 
59 /* data structure describing a computed auth vector, generated by AuC */
61  uint8_t rand[16];
62  uint8_t autn[16];
63  uint8_t ck[16];
64  uint8_t ik[16];
65  uint8_t res[16];
66  uint8_t res_len;
67  uint8_t kc[8];
68  uint8_t sres[4];
69  uint32_t auth_types;
70 };
71 
72 /* An implementation of an authentication algorithm */
74  struct llist_head list;
76  const char *name;
77  unsigned int priority;
80  int (*gen_vec)(struct osmo_auth_vector *vec,
81  struct osmo_sub_auth_data *aud,
82  const uint8_t *_rand);
83 
84  /* callback for generationg auth vectors + re-sync */
85  int (*gen_vec_auts)(struct osmo_auth_vector *vec,
86  struct osmo_sub_auth_data *aud,
87  const uint8_t *auts, const uint8_t *rand_auts,
88  const uint8_t *_rand);
89 };
90 
91 int osmo_auth_gen_vec(struct osmo_auth_vector *vec,
92  struct osmo_sub_auth_data *aud, const uint8_t *_rand);
93 
95  struct osmo_sub_auth_data *aud,
96  const uint8_t *auts, const uint8_t *rand_auts,
97  const uint8_t *_rand);
98 
99 int osmo_auth_register(struct osmo_auth_impl *impl);
100 
101 int osmo_auth_load(const char *path);
102 
104 void osmo_c4(uint8_t *ck, const uint8_t *kc);
105 const char *osmo_auth_alg_name(enum osmo_auth_algo alg);
106 enum osmo_auth_algo osmo_auth_alg_parse(const char *name);
107 
108 void osmo_auth_c3(uint8_t kc[], const uint8_t ck[], const uint8_t ik[]);
109 
110 /* @} */
const char * name
name of the implementation
Definition: auth.h:76
const char * get_value_string(const struct value_string *vs, uint32_t val)
enum osmo_sub_auth_type type
Definition: auth.h:40
void osmo_auth_c3(uint8_t kc[], const uint8_t ck[], const uint8_t ik[])
Definition: auth_core.c:245
Definition: auth.h:30
permanent (secret) subscriber auth data
Definition: auth.h:39
uint64_t sqn_ms
sqn from AUTS (output value only)
Definition: auth.h:51
#define OSMO_A5_MAX_KEY_LEN_BYTES
Definition: auth.h:12
unsigned int ind_bitlen
nr of bits not in SEQ, only SQN
Definition: auth.h:49
Definition: auth.h:33
unsigned int priority
priority value (resp.
Definition: auth.h:77
Definition: auth.h:18
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
uint8_t res_len
length (in bytes) of res
Definition: auth.h:66
struct osmo_sub_auth_data::@35::@36 umts
osmo_auth_algo
Authentication Algorithm.
Definition: auth.h:28
void osmo_c4(uint8_t *ck, const uint8_t *kc)
Definition: auth_core.c:114
uint8_t k[16]
secret key of the subscriber
Definition: auth.h:45
uint8_t opc[16]
operator invariant value
Definition: auth.h:44
uint32_t auth_types
bitmask of OSMO_AUTH_TYPE_*
Definition: auth.h:69
unsigned int ind
which IND slot to use an SQN from
Definition: auth.h:50
uint8_t rand[16]
Definition: gsm_04_08.h:504
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
union osmo_sub_auth_data::@35 u
struct osmo_sub_auth_data::@35::@37 gsm
Definition: auth.h:17
uint8_t ki[OSMO_A5_MAX_KEY_LEN_BYTES]
secret key
Definition: auth.h:54
uint8_t res
Definition: auth.h:73
enum osmo_auth_algo osmo_auth_alg_parse(const char *name)
Parse human-readable name of authentication algorithm.
Definition: auth_core.c:227
Definition: auth.h:31
const char * osmo_auth_alg_name(enum osmo_auth_algo alg)
Get human-readable name of authentication algorithm.
Definition: auth_core.c:221
Definition: auth.h:34
int osmo_auth_load(const char *path)
Load all available authentication plugins from the given path.
Definition: auth_core.c:73
uint8_t amf[2]
Definition: auth.h:46
Definition: auth.h:29
uint8_t sres[4]
Definition: gsm_04_08.h:502
Definition: auth.h:19
uint64_t sqn
sequence number (in: prev sqn; out: used sqn)
Definition: auth.h:47
int opc_is_op
is the OPC field OPC (0) or OP (1) ?
Definition: auth.h:48
Definition: auth.h:35
Definition: auth.h:32
static const char * osmo_sub_auth_type_name(enum osmo_sub_auth_type val)
Definition: auth.h:23
enum osmo_auth_algo algo
Definition: auth.h:41
Definition: auth.h:60
osmo_sub_auth_type
Authentication Type (GSM/UMTS)
Definition: auth.h:16
int osmo_auth_supported(enum osmo_auth_algo algo)
Determine if a given authentication algorithm is supported.
Definition: auth_core.c:90
const struct value_string osmo_sub_auth_type_names[]
Definition: auth_core.c:232
int osmo_auth_register(struct osmo_auth_impl *impl)
Register an authentication algorithm implementation with the core.
Definition: auth_core.c:52