[doc] gea has separate group; A5 is not part of crypto but a5 group

Change-Id: I2fd24c86f9b52244073ec800a3287e3d38e660d9
This commit is contained in:
Harald Welte 2017-10-16 16:00:36 +02:00
parent c368b5420a
commit 8cc2767891
4 changed files with 18 additions and 18 deletions

View File

@ -1,5 +1,3 @@
/*! \file gsm/a5.h
* Osmocom GSM A5 ciphering algorithm header. */
/*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
*

View File

@ -1,5 +1,8 @@
/*! \file gea.h
* GEA3 header.
/*! \defgroup gea GPRS GEA3/GEA4 ciphering algorithm
* @{
* \file gea.h
*
* GEA3/GEA4 header.
*
* See gea.c for details
*/
@ -15,3 +18,5 @@ int gea3(uint8_t *out, uint16_t len, uint8_t *kc, uint32_t iv,
int gea4(uint8_t *out, uint16_t len, uint8_t *kc, uint32_t iv,
enum gprs_cipher_direction direct);
/*! @} */

View File

@ -1,10 +1,3 @@
/*! \file a5.c
* Full reimplementation of A5/1,2 (split and threadsafe).
*
* The logic behind the algorithm is taken from "A pedagogical implementation
* of the GSM A5/1 and A5/2 "voice privacy" encryption algorithms." by
* Marc Briceno, Ian Goldberg, and David Wagner.
*/
/*
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
*
@ -25,11 +18,16 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/*! \addtogroup crypto
/*! \addtogroup a5
* @{
* Osmocom GSM/GPRS ciphering algorithm implementation
* Osmocom GSM ciphering algorithm implementation
*
* \file gsm/a5.c */
* Full reimplementation of A5/1,2,3,4 (split and threadsafe).
*
* The logic behind the algorithm is taken from "A pedagogical implementation
* of the GSM A5/1 and A5/2 "voice privacy" encryption algorithms." by
* Marc Briceno, Ian Goldberg, and David Wagner.
*/
#include <errno.h>
#include <string.h>

View File

@ -1,5 +1,3 @@
/*! \file gea.c
* Implementation of GEA3 and GEA4. */
/*
* Copyright (C) 2016 by Sysmocom s.f.m.c. GmbH
*
@ -28,9 +26,10 @@
#include <stdint.h>
#include <string.h>
/*! \addtogroup crypto
/*! \addtogroup gea
* @{
* \file gsm/gea.c */
* Implementation of GPRS Ciphers GEA3 and GEA4.
* \file gea.c */
/*! Performs the GEA4 algorithm as in 3GPP TS 55.226 V9.0.0
* \param[in,out] out Buffer for gamma for encrypted/decrypted