libosmogsm  1.9.0.155-9d73.202402222026
Osmocom GSM library
oap_client.h
Go to the documentation of this file.
1 /* Osmocom Authentication Protocol API */
2 
3 /* (C) 2015 by Sysmocom s.f.m.c. GmbH
4  * All Rights Reserved
5  *
6  * Author: Neels Hofmeyr
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  *
21  * SPDX-License-Identifier: GPL-2.0+
22  */
23 
24 #pragma once
25 
26 #include <stdint.h>
27 
28 struct msgb;
29 struct osmo_oap_message;
30 
31 /* This is the config part for vty. It is essentially copied in
32  * oap_client_state, where values are copied over once the config is
33  * considered valid. */
35  uint16_t client_id;
37  uint8_t secret_k[16];
39  uint8_t secret_opc[16];
40 };
41 
42 /* The runtime state of the OAP client. client_id and the secrets are in fact
43  * duplicated from oap_client_config, so that a separate validation of the
44  * config data is possible, and so that only a struct oap_client_state* is
45  * passed around. */
47  enum {
48  OSMO_OAP_UNINITIALIZED = 0, /* just allocated. */
49  OSMO_OAP_DISABLED, /* disabled by config. */
50  OSMO_OAP_INITIALIZED, /* enabled, config is valid. */
54  } state;
55  uint16_t client_id;
56  uint8_t secret_k[16];
57  uint8_t secret_opc[16];
59 };
60 
61 /* From config, initialize state. Return 0 on success. */
63  struct osmo_oap_client_state *state);
64 
65 /* Construct an OAP registration message and return in *msg_tx. Use
66  * state->client_id and update state->state.
67  * Return 0 on success, or a negative value on error.
68  * If an error is returned, *msg_tx is guaranteed to be NULL. */
69 int osmo_oap_client_register(struct osmo_oap_client_state *state, struct msgb **msg_tx);
70 
71 /* Decode and act on a received OAP message msg_rx. Update state->state. If a
72  * non-NULL pointer is returned in *msg_tx, that msgb should be sent to the OAP
73  * server (and freed) by the caller. The received msg_rx is not freed.
74  * Return 0 on success, or a negative value on error.
75  * If an error is returned, *msg_tx is guaranteed to be NULL. */
77  const struct msgb *msg_rx, struct msgb **msg_tx);
78 
79 /* Allocate a msgb and in it, return the encoded oap_client_msg. Return
80  * NULL on error. (Like oap_client_encode(), but also allocates a msgb.)
81  * About the name: the idea is do_something(oap_client_encoded(my_struct))
82  */
83 struct msgb *osmo_oap_client_encoded(const struct osmo_oap_message *oap_client_msg);
write Write running configuration to or terminal n Write configuration to the copy running config startup config
struct msgb * osmo_oap_client_encoded(const struct osmo_oap_message *oap_client_msg)
Definition: oap_client.c:129
int osmo_oap_client_handle(struct osmo_oap_client_state *state, const struct msgb *msg_rx, struct msgb **msg_tx)
Definition: oap_client.c:213
int osmo_oap_client_init(struct osmo_oap_client_config *config, struct osmo_oap_client_state *state)
Definition: oap_client.c:35
int osmo_oap_client_register(struct osmo_oap_client_state *state, struct msgb **msg_tx)
Definition: oap_client.c:153
Definition: oap_client.h:34
uint8_t secret_k[16]
Definition: oap_client.h:37
int secret_opc_present
Definition: oap_client.h:38
uint16_t client_id
Definition: oap_client.h:35
int secret_k_present
Definition: oap_client.h:36
uint8_t secret_opc[16]
Definition: oap_client.h:39
Definition: oap_client.h:46
enum osmo_oap_client_state::@27 state
uint16_t client_id
Definition: oap_client.h:55
uint8_t secret_k[16]
Definition: oap_client.h:56
@ OSMO_OAP_UNINITIALIZED
Definition: oap_client.h:48
@ OSMO_OAP_INITIALIZED
Definition: oap_client.h:50
@ OSMO_OAP_REQUESTED_CHALLENGE
Definition: oap_client.h:51
@ OSMO_OAP_DISABLED
Definition: oap_client.h:49
@ OSMO_OAP_REGISTERED
Definition: oap_client.h:53
@ OSMO_OAP_SENT_CHALLENGE_RESULT
Definition: oap_client.h:52
int registration_failures
Definition: oap_client.h:58
uint8_t secret_opc[16]
Definition: oap_client.h:57
Parsed/decoded OAP protocol message.
Definition: oap.h:65