osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 0
Code Issues Releases Wiki Activity

[doc] Properly define 'oap' group and add introductory text 

Change-Id: I1e875991ae1dd93862f850f85d40b3dac61ece72
This commit is contained in:
Harald Welte 2017-10-16 18:34:14 +02:00
parent 381a1aa1c1
commit a338983d3b
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/osmocom/gsm/oap.h
View File

@ -1,5 +1,12 @@
/*! \file oap.h
* Osmocom Authentication Protocol message encoder/decoder. */
/*! \defgroup oap Osmocom Authentication Protocol
* @{
*
* The Osmocom Authentication Protocol (OAP) is a way to use the 3GPP
* AKA (Authentication and Key Agreement) as cryptographic
* authentication mechanism in other protocols that don't provide
* cryptographic authentication.
*
* \file oap.h */
/*
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
@ -71,3 +78,5 @@ struct osmo_oap_message {
int osmo_oap_decode(struct osmo_oap_message *oap_msg, const uint8_t *data,
size_t data_len);
void osmo_oap_encode(struct msgb *msg, const struct osmo_oap_message *oap_msg);
/*! @} */

3
src/gsm/oap.c
View File

@ -1,5 +1,3 @@
/*! \file oap.c
* Osmocom Authentication Protocol message encoder/decoder */
/*
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
@ -31,6 +29,7 @@
/*! \addtogroup oap
* @{
* \file oap.c
* Osmocom Authentication Protocol
*/