osip_authorization.h
10.2 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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/*
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_AUTHORIZATION_H_
#define _OSIP_AUTHORIZATION_H_
/**
* @file osip_authorization.h
* @brief oSIP osip_authorization header definition.
*/
/**
* @defgroup oSIP_AUTHORIZATION oSIP authorization header definition.
* @ingroup oSIP_HEADERS
* @{
*/
/**
* Structure for Authorization headers.
* @var osip_authorization_t
*/
typedef struct osip_authorization osip_authorization_t;
/**
* Definition of the Authorization header.
* @struct osip_authorization
*/
struct osip_authorization {
char *auth_type; /**< Authentication Type (Basic or Digest) */
char *username; /**< login */
char *realm; /**< realm (as a quoted-string) */
char *nonce; /**< nonce */
char *uri; /**< uri */
char *response; /**< response */
char *digest; /**< digest */
char *algorithm; /**< algorithm (optionnal) */
char *cnonce; /**< cnonce (optionnal) */
char *opaque; /**< opaque (optionnal) */
char *message_qop; /**< message_qop (optionnal) */
char *nonce_count; /**< nonce_count (optionnal) */
char *version; /**< version (optional - NTLM) */
char *targetname; /**< targetname (optional - NTLM) */
char *gssapi_data; /**< gssapi-data (optional - NTLM) */
char *crand;
char *cnum;
char *auth_param; /**< other parameters (optionnal) */
};
#ifdef __cplusplus
extern "C" {
#endif
/**
* Allocate a Authorization element.
* @param header The element to work on.
*/
int osip_authorization_init(osip_authorization_t **header);
/**
* Parse a Authorization element.
* @param header The element to work on.
* @param hvalue The string to parse.
*/
int osip_authorization_parse(osip_authorization_t *header, const char *hvalue);
/**
* Get a string representation of a Authorization element.
* @param header The element to work on.
* @param dest A pointer on the new allocated string.
*/
int osip_authorization_to_str(const osip_authorization_t *header, char **dest);
/**
* Free a Authorization element.
* @param header The element to work on.
*/
void osip_authorization_free(osip_authorization_t *header);
/**
* Clone a Authorization element.
* @param header The element to work on.
* @param dest A pointer on the copy of the element.
*/
int osip_authorization_clone(const osip_authorization_t *header, osip_authorization_t **dest);
/**
* Get value of the auth_type parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_auth_type(const osip_authorization_t *header);
/**
* Add the auth_type parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_auth_type(osip_authorization_t *header, char *value);
/**
* Get value of the username parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_username(osip_authorization_t *header);
/**
* Add the username parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_username(osip_authorization_t *header, char *value);
/**
* Get value of the realm parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_realm(osip_authorization_t *header);
/**
* Add the realm parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_realm(osip_authorization_t *header, char *value);
/**
* Get value of the nonce parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_nonce(osip_authorization_t *header);
/**
* Add the nonce parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_nonce(osip_authorization_t *header, char *value);
/**
* Get value of the uri parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_uri(osip_authorization_t *header);
/**
* Add the uri parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_uri(osip_authorization_t *header, char *value);
/**
* Get value of the response parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_response(osip_authorization_t *header);
/**
* Add the response parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_response(osip_authorization_t *header, char *value);
/**
* Get value of the digest parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_digest(osip_authorization_t *header);
/**
* Add the digest parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_digest(osip_authorization_t *header, char *value);
/**
* Get value of the algorithm parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_algorithm(osip_authorization_t *header);
/**
* Add the algorithm parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_algorithm(osip_authorization_t *header, char *value);
/**
* Get value of the cnonce parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_cnonce(osip_authorization_t *header);
/**
* Add the cnonce parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_cnonce(osip_authorization_t *header, char *value);
/**
* Get value of the opaque parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_opaque(osip_authorization_t *header);
/**
* Add the opaque parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_opaque(osip_authorization_t *header, char *value);
/**
* Get value of the message_qop parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_message_qop(osip_authorization_t *header);
/**
* Add the message_qop parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_message_qop(osip_authorization_t *header, char *value);
/**
* Get value of the nonce_count parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_nonce_count(osip_authorization_t *header);
/**
* Add the nonce_count parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_nonce_count(osip_authorization_t *header, char *value);
/**
* Get value of the version parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_version(osip_authorization_t *header);
/**
* Add the version parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_version(osip_authorization_t *header, char *value);
/**
* Get value of the targetname parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_targetname(osip_authorization_t *header);
/**
* Add the targetname parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_targetname(osip_authorization_t *header, char *value);
/**
* Get value of the gssapi_data parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_gssapi_data(osip_authorization_t *header);
/**
* Add the gssapi_data parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_gssapi_data(osip_authorization_t *header, char *value);
/**
* Get value of the crand parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_crand(osip_authorization_t *header);
/**
* Add the crand parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_crand(osip_authorization_t *header, char *value);
/**
* Get value of the cnum parameter from a Authorization element.
* @param header The element to work on.
*/
char *osip_authorization_get_cnum(osip_authorization_t *header);
/**
* Add the gssapi_data parameter from a Authorization element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_authorization_set_cnum(osip_authorization_t *header, char *value);
#ifdef __cplusplus
}
#endif
/** @} */
#endif