blob: 4af8ca8e9b7c5ccc4b1df12affa73948d65872f8 [file] [log] [blame]
Sylvain Munaut12ba7782014-06-16 10:13:40 +02001#pragma once
Harald Welted82e0eb2011-12-06 21:53:42 +01002
Harald Weltec368b542017-10-16 16:00:06 +02003/*! \defgroup auth GSM/GPRS/3G Authentication
Harald Welte007a71e2012-07-18 19:47:56 +02004 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02005 * \file auth.h */
Harald Welte007a71e2012-07-18 19:47:56 +02006
Harald Welted82e0eb2011-12-06 21:53:42 +01007#include <stdint.h>
8
9#include <osmocom/core/linuxlist.h>
Neels Hofmeyr26e30b12017-10-07 04:41:22 +020010#include <osmocom/core/utils.h>
Harald Welted82e0eb2011-12-06 21:53:42 +010011
Max483cdff2017-08-28 10:38:59 +020012#define OSMO_A5_MAX_KEY_LEN_BYTES (128/8)
Neels Hofmeyr1a02e362017-10-07 04:44:08 +020013#define OSMO_MILENAGE_IND_BITLEN_MAX 28
Max483cdff2017-08-28 10:38:59 +020014
Neels Hofmeyr87e45502017-06-20 00:17:59 +020015/*! Authentication Type (GSM/UMTS) */
Harald Welted82e0eb2011-12-06 21:53:42 +010016enum osmo_sub_auth_type {
17 OSMO_AUTH_TYPE_NONE = 0x00,
18 OSMO_AUTH_TYPE_GSM = 0x01,
19 OSMO_AUTH_TYPE_UMTS = 0x02,
20};
21
Neels Hofmeyr26e30b12017-10-07 04:41:22 +020022extern const struct value_string osmo_sub_auth_type_names[];
23static inline const char *osmo_sub_auth_type_name(enum osmo_sub_auth_type val)
24{ return get_value_string(osmo_sub_auth_type_names, val); }
25
26/*! Authentication Algorithm.
27 * See also osmo_auth_alg_name() and osmo_auth_alg_parse(). */
Harald Welted82e0eb2011-12-06 21:53:42 +010028enum osmo_auth_algo {
29 OSMO_AUTH_ALG_NONE,
30 OSMO_AUTH_ALG_COMP128v1,
31 OSMO_AUTH_ALG_COMP128v2,
32 OSMO_AUTH_ALG_COMP128v3,
33 OSMO_AUTH_ALG_XOR,
34 OSMO_AUTH_ALG_MILENAGE,
Harald Weltee93c5e92023-02-21 22:18:11 +010035 OSMO_AUTH_ALG_XOR_2G,
Harald Welted82e0eb2011-12-06 21:53:42 +010036 _OSMO_AUTH_ALG_NUM,
37};
38
Neels Hofmeyr87e45502017-06-20 00:17:59 +020039/*! permanent (secret) subscriber auth data */
Harald Welted82e0eb2011-12-06 21:53:42 +010040struct osmo_sub_auth_data {
41 enum osmo_sub_auth_type type;
42 enum osmo_auth_algo algo;
43 union {
44 struct {
Harald Welte007a71e2012-07-18 19:47:56 +020045 uint8_t opc[16]; /*!< operator invariant value */
Maxaf25c372018-12-19 20:12:19 +010046 uint8_t k[OSMO_A5_MAX_KEY_LEN_BYTES]; /*!< secret key of the subscriber */
Harald Welted82e0eb2011-12-06 21:53:42 +010047 uint8_t amf[2];
Neels Hofmeyr95500c82017-08-26 22:38:08 +020048 uint64_t sqn; /*!< sequence number (in: prev sqn; out: used sqn) */
Harald Welte007a71e2012-07-18 19:47:56 +020049 int opc_is_op; /*!< is the OPC field OPC (0) or OP (1) ? */
Neels Hofmeyrbb6f7b72017-03-13 17:27:17 +010050 unsigned int ind_bitlen; /*!< nr of bits not in SEQ, only SQN */
Neels Hofmeyr95500c82017-08-26 22:38:08 +020051 unsigned int ind; /*!< which IND slot to use an SQN from */
Neels Hofmeyr2066a422017-08-26 22:43:50 +020052 uint64_t sqn_ms; /*!< sqn from AUTS (output value only) */
Harald Welted82e0eb2011-12-06 21:53:42 +010053 } umts;
54 struct {
Max483cdff2017-08-28 10:38:59 +020055 uint8_t ki[OSMO_A5_MAX_KEY_LEN_BYTES]; /*!< secret key */
Harald Welted82e0eb2011-12-06 21:53:42 +010056 } gsm;
Harald Welteaae23622011-12-07 11:35:02 +010057 } u;
Harald Welted82e0eb2011-12-06 21:53:42 +010058};
59
60/* data structure describing a computed auth vector, generated by AuC */
61struct osmo_auth_vector {
Harald Welte007a71e2012-07-18 19:47:56 +020062 uint8_t rand[16]; /*!< random challenge */
63 uint8_t autn[16]; /*!< authentication nonce */
Maxaf25c372018-12-19 20:12:19 +010064 uint8_t ck[OSMO_A5_MAX_KEY_LEN_BYTES]; /*!< ciphering key */
65 uint8_t ik[OSMO_A5_MAX_KEY_LEN_BYTES]; /*!< integrity key */
Harald Welte007a71e2012-07-18 19:47:56 +020066 uint8_t res[16]; /*!< authentication result */
67 uint8_t res_len; /*!< length (in bytes) of res */
68 uint8_t kc[8]; /*!< Kc for GSM encryption (A5) */
69 uint8_t sres[4]; /*!< authentication result for GSM */
Harald Welted82e0eb2011-12-06 21:53:42 +010070 uint32_t auth_types; /*!< bitmask of OSMO_AUTH_TYPE_* */
71};
72
Neels Hofmeyr87e45502017-06-20 00:17:59 +020073/* An implementation of an authentication algorithm */
Harald Welted82e0eb2011-12-06 21:53:42 +010074struct osmo_auth_impl {
75 struct llist_head list;
Harald Welte007a71e2012-07-18 19:47:56 +020076 enum osmo_auth_algo algo; /*!< algorithm we implement */
77 const char *name; /*!< name of the implementation */
78 unsigned int priority; /*!< priority value (resp. othe implementations */
Harald Welted82e0eb2011-12-06 21:53:42 +010079
Neels Hofmeyr87e45502017-06-20 00:17:59 +020080 /*! callback for generate authentication vectors */
Harald Welted82e0eb2011-12-06 21:53:42 +010081 int (*gen_vec)(struct osmo_auth_vector *vec,
82 struct osmo_sub_auth_data *aud,
83 const uint8_t *_rand);
84
Neels Hofmeyr87e45502017-06-20 00:17:59 +020085 /* callback for generationg auth vectors + re-sync */
Harald Welted82e0eb2011-12-06 21:53:42 +010086 int (*gen_vec_auts)(struct osmo_auth_vector *vec,
87 struct osmo_sub_auth_data *aud,
Neels Hofmeyr03ab9a62017-02-03 05:00:24 +010088 const uint8_t *auts, const uint8_t *rand_auts,
Harald Welted82e0eb2011-12-06 21:53:42 +010089 const uint8_t *_rand);
90};
91
92int osmo_auth_gen_vec(struct osmo_auth_vector *vec,
93 struct osmo_sub_auth_data *aud, const uint8_t *_rand);
94
95int osmo_auth_gen_vec_auts(struct osmo_auth_vector *vec,
96 struct osmo_sub_auth_data *aud,
Neels Hofmeyr03ab9a62017-02-03 05:00:24 +010097 const uint8_t *auts, const uint8_t *rand_auts,
Harald Welted82e0eb2011-12-06 21:53:42 +010098 const uint8_t *_rand);
99
100int osmo_auth_register(struct osmo_auth_impl *impl);
101
102int osmo_auth_load(const char *path);
103
104int osmo_auth_supported(enum osmo_auth_algo algo);
Maxceae1232016-06-27 18:12:49 +0200105void osmo_c4(uint8_t *ck, const uint8_t *kc);
Harald Weltea5ab1622011-12-07 02:33:11 +0100106const char *osmo_auth_alg_name(enum osmo_auth_algo alg);
107enum osmo_auth_algo osmo_auth_alg_parse(const char *name);
108
Neels Hofmeyraa84b712017-12-18 03:12:01 +0100109void osmo_auth_c3(uint8_t kc[], const uint8_t ck[], const uint8_t ik[]);
110
Harald Welte007a71e2012-07-18 19:47:56 +0200111/* @} */