Clean up doxygen warnings
[asterisk/asterisk.git] / channels / sip / include / srtp.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006 - 2007, Mikael Magnusson
5  *
6  * Mikael Magnusson <mikma@users.sourceforge.net>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file srtp.h
20  *
21  * \brief SIP Secure RTP (SRTP)
22  *
23  * Specified in RFC 3711
24  *
25  * \author Mikael Magnusson <mikma@users.sourceforge.net>
26  */
27
28 #ifndef _SIP_SRTP_H
29 #define _SIP_SRTP_H
30
31 #include "sdp_crypto.h"
32
33 /* SRTP flags */
34 #define SRTP_ENCR_OPTIONAL      (1 << 1)        /* SRTP encryption optional */
35 #define SRTP_CRYPTO_ENABLE      (1 << 2)
36 #define SRTP_CRYPTO_OFFER_OK    (1 << 3)
37 #define SRTP_CRYPTO_TAG_32      (1 << 4)
38 #define SRTP_CRYPTO_TAG_80      (1 << 5)
39
40 /*! \brief structure for secure RTP audio */
41 struct sip_srtp {
42         unsigned int flags;
43         struct sdp_crypto *crypto;
44 };
45
46 /*!
47  * \brief allocate a sip_srtp structure
48  * \retval a new malloc'd sip_srtp structure on success
49  * \retval NULL on failure
50 */
51 struct sip_srtp *sip_srtp_alloc(void);
52
53 /*!
54  * \brief free a sip_srtp structure
55  * \param srtp a sip_srtp structure
56 */
57 void sip_srtp_destroy(struct sip_srtp *srtp);
58
59 #endif  /* _SIP_SRTP_H */