libosmogsm  1.10.0.56-fc03.202412192026
Osmocom GSM library
gprs_cipher.h
Go to the documentation of this file.
1 
3 #pragma once
4 
6 #include <osmocom/core/utils.h>
7 
8 #include <stdint.h>
9 
10 #define GSM0464_CIPH_MAX_BLOCK 1523
11 
12 /* 3GPP TS 24.008 ยง 10.5.5.3 */
20 };
21 
22 /* 3GPP TS 04.64 Table A.1: */
26 };
27 
28 extern const struct value_string gprs_cipher_names[];
29 
30 /* An implementation of a GPRS cipher */
32  struct llist_head list;
33  enum gprs_ciph_algo algo;
34  const char *name;
35  unsigned int priority;
36 
37  /* As specified in 04.64 Annex A. Uses Kc, IV and direction
38  * to generate the 1523 bytes cipher stream that need to be
39  * XORed wit the plaintext for encrypt / ciphertext for decrypt */
40  int (*run)(uint8_t *out, uint16_t len, uint8_t *kc, uint32_t iv,
41  enum gprs_cipher_direction direction);
42 };
43 
44 /* register a cipher with the core (from a plugin) */
45 int gprs_cipher_register(struct gprs_cipher_impl *ciph);
46 
47 /* load all available GPRS cipher plugins */
48 int gprs_cipher_load(const char *path);
49 
50 /* function to be called by core code */
51 int gprs_cipher_run(uint8_t *out, uint16_t len, enum gprs_ciph_algo algo,
52  uint8_t *kc, uint32_t iv, enum gprs_cipher_direction dir);
53 
54 /* Do we have an implementation for this cipher? */
56 
57 /* Return key length for supported cipher, in bytes */
58 unsigned gprs_cipher_key_length(enum gprs_ciph_algo algo);
59 
60 /* GSM TS 04.64 / Section A.2.1 : Generation of 'input' */
61 uint32_t gprs_cipher_gen_input_ui(uint32_t iov_ui, uint8_t sapi, uint32_t lfn, uint32_t oc);
62 
63 /* GSM TS 04.64 / Section A.2.1 : Generation of 'input' */
64 uint32_t gprs_cipher_gen_input_i(uint32_t iov_i, uint32_t lfn, uint32_t oc);
gprs_ciph_algo
Definition: gprs_cipher.h:13
@ GPRS_ALGO_GEA1
Definition: gprs_cipher.h:15
@ GPRS_ALGO_GEA3
Definition: gprs_cipher.h:17
@ _GPRS_ALGO_NUM
Definition: gprs_cipher.h:19
@ GPRS_ALGO_GEA4
Definition: gprs_cipher.h:18
@ GPRS_ALGO_GEA2
Definition: gprs_cipher.h:16
@ GPRS_ALGO_GEA0
Definition: gprs_cipher.h:14
gprs_cipher_direction
Definition: gprs_cipher.h:23
@ GPRS_CIPH_MS2SGSN
Definition: gprs_cipher.h:24
@ GPRS_CIPH_SGSN2MS
Definition: gprs_cipher.h:25
uint32_t gprs_cipher_gen_input_ui(uint32_t iov_ui, uint8_t sapi, uint32_t lfn, uint32_t oc)
Definition: gprs_cipher_core.c:123
unsigned gprs_cipher_key_length(enum gprs_ciph_algo algo)
Obtain key lenght for given GPRS cipher.
Definition: gprs_cipher_core.c:99
int gprs_cipher_run(uint8_t *out, uint16_t len, enum gprs_ciph_algo algo, uint8_t *kc, uint32_t iv, enum gprs_cipher_direction dir)
Definition: gprs_cipher_core.c:78
int gprs_cipher_supported(enum gprs_ciph_algo algo)
Definition: gprs_cipher_core.c:111
const struct value_string gprs_cipher_names[]
Definition: gprs_cipher_core.c:41
int gprs_cipher_register(struct gprs_cipher_impl *ciph)
Definition: gprs_cipher_core.c:51
int gprs_cipher_load(const char *path)
Definition: gprs_cipher_core.c:67
uint32_t gprs_cipher_gen_input_i(uint32_t iov_i, uint32_t lfn, uint32_t oc)
Definition: gprs_cipher_core.c:131
uint8_t len
Definition: gsm_04_11.h:0
Definition: gprs_cipher.h:31
enum gprs_ciph_algo algo
Definition: gprs_cipher.h:33
unsigned int priority
Definition: gprs_cipher.h:35
int(* run)(uint8_t *out, uint16_t len, uint8_t *kc, uint32_t iv, enum gprs_cipher_direction direction)
Definition: gprs_cipher.h:40
struct llist_head list
Definition: gprs_cipher.h:32
const char * name
Definition: gprs_cipher.h:34