osip_authentication_info.h
7.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.com
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _OSIP_AUTHENTICATION_INFO_H_
#define _OSIP_AUTHENTICATION_INFO_H_
/**
* @file osip_authentication_info.h
* @brief oSIP osip_authentication_info header definition.
*/
/**
* @defgroup oSIP_AUTH_INFO oSIP authentication-info header definition.
* @ingroup oSIP_HEADERS
* @{
*/
/**
* Structure for Authentication-Info headers.
* @var osip_authentication_info_t
*/
typedef struct osip_authentication_info osip_authentication_info_t;
/**
* Definition of the Authentication-Info header.
* @struct osip_authentication_info
*/
struct osip_authentication_info {
char *auth_type; /**< Authentication Type (Basic or Digest) */
char *nextnonce; /**< nextnonce value */
char *qop_options; /**< qop options value */
char *rspauth; /**< rspauth value */
char *cnonce; /**< cnonce value */
char *nonce_count; /**< noncecount value */
char *snum; /**< snum value */
char *srand; /**< srand value */
char *realm; /**< realm value */
char *targetname; /**< targetname value */
char *opaque; /**< opaque value */
};
#ifdef __cplusplus
extern "C" {
#endif
/**
* Allocate a Authenication-Info element.
* @param header The element to work on.
*/
int osip_authentication_info_init(osip_authentication_info_t **header);
/**
* Parse a Authenication-Info element.
* @param header The element to work on.
* @param hvalue The string to parse.
*/
int osip_authentication_info_parse(osip_authentication_info_t *header, const char *hvalue);
/**
* Get a string representation of a Authenication-Info element.
* @param header The element to work on.
* @param dest A pointer on the new allocated string.
*/
int osip_authentication_info_to_str(const osip_authentication_info_t *header, char **dest);
/**
* Free a Authenication-Info element.
* @param header The element to work on.
*/
void osip_authentication_info_free(osip_authentication_info_t *header);
/**
* Clone a Authenication-Info element.
* @param header The element to work on.
* @param dest A pointer on the copy of the element.
*/
int osip_authentication_info_clone(const osip_authentication_info_t *header, osip_authentication_info_t **dest);
/**
* Get value of the auth_type parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_auth_type(osip_authentication_info_t *header);
/**
* Add the auth_type parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_auth_type(osip_authentication_info_t *header, char *value);
/**
* Get value of the nextnonce parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_nextnonce(osip_authentication_info_t *header);
/**
* Add the nextnonce parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_nextnonce(osip_authentication_info_t *header, char *value);
/**
* Get value of the cnonce parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_cnonce(osip_authentication_info_t *header);
/**
* Add the cnonce parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_cnonce(osip_authentication_info_t *header, char *value);
/**
* Get value of the qop_options parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_qop_options(osip_authentication_info_t *header);
/**
* Add the qop_options parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_qop_options(osip_authentication_info_t *header, char *value);
/**
* Get value of the rspauth parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_rspauth(osip_authentication_info_t *header);
/**
* Add the rspauth parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_rspauth(osip_authentication_info_t *header, char *value);
/**
* Get value of the nc parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_nonce_count(osip_authentication_info_t *header);
/**
* Add the nc parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_nonce_count(osip_authentication_info_t *header, char *value);
/**
* Get value of the snum parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_snum(osip_authentication_info_t *header);
/**
* Add the snum parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_snum(osip_authentication_info_t *header, char *value);
/**
* Get value of the srand parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_srand(osip_authentication_info_t *header);
/**
* Add the srand parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_srand(osip_authentication_info_t *header, char *value);
/**
* Get value of the targetname parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_targetname(osip_authentication_info_t *header);
/**
* Add the targetname parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_targetname(osip_authentication_info_t *header, char *value);
/**
* Get value of the realm parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_realm(osip_authentication_info_t *header);
/**
* Add the realm parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_realm(osip_authentication_info_t *header, char *value);
/**
* Get value of the opaque parameter from a Authenication-Info element.
* @param header The element to work on.
*/
char *osip_authentication_info_get_opaque(osip_authentication_info_t *header);
/**
* Add the opaque parameter from a Authenication-Info element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authentication_info_set_opaque(osip_authentication_info_t *header, char *value);
#ifdef __cplusplus
}
#endif
/** @} */
#endif