osip_www_authenticate.h
8.52 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
/*
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_WWW_AUTHENTICATE_H_
#define _OSIP_WWW_AUTHENTICATE_H_
/**
* @file osip_www_authenticate.h
* @brief oSIP osip_www_authenticate header definition.
*/
/**
* @defgroup oSIP_WWW_AUTHENTICATE oSIP www-authenticate header definition.
* @ingroup oSIP_HEADERS
* @{
*/
/**
* Structure for WWW-Authenticate headers.
* @var osip_www_authenticate_t
*/
typedef struct osip_www_authenticate osip_www_authenticate_t;
/**
* Definition of the WWW-Authenticate header.
* @struct osip_www_authenticate
*/
struct osip_www_authenticate {
char *auth_type; /**< Authentication Type (Basic or Digest */
char *realm; /**< realm (as a quoted-string) */
char *domain; /**< domain (optional) */
char *nonce; /**< nonce (optional)*/
char *opaque; /**< opaque (optional) */
char *stale; /**< stale (optional) */
char *algorithm; /**< algorythm (optional) */
char *qop_options; /**< qop option (optional) */
char *version; /**< version (optional - NTLM) */
char *targetname; /**< targetname (optional - NTLM) */
char *gssapi_data; /**< gssapi-data (optional - NTLM) */
char *auth_param; /**< other parameters (optional) */
};
#ifdef __cplusplus
extern "C" {
#endif
/**
* Allocate a Www-Authenticate element.
* @param header The element to work on.
*/
int osip_www_authenticate_init(osip_www_authenticate_t **header);
/**
* Parse a Www-Authenticate element.
* @param header The element to work on.
* @param hvalue The string to parse.
*/
int osip_www_authenticate_parse(osip_www_authenticate_t *header, const char *hvalue);
/**
* Get a string representation of a Www-Authenticate element.
* @param header The element to work on.
* @param dest A pointer on the new allocated string.
*/
int osip_www_authenticate_to_str(const osip_www_authenticate_t *header, char **dest);
/**
* Free a Www-Authenticate element.
* @param header The element to work on.
*/
void osip_www_authenticate_free(osip_www_authenticate_t *header);
/**
* Clone a Www-Authenticate element.
* @param header The element to work on.
* @param dest A pointer on the copy of the element.
*/
int osip_www_authenticate_clone(const osip_www_authenticate_t *header, osip_www_authenticate_t **dest);
/**
* Get value of the auth_type parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_auth_type(osip_www_authenticate_t *header);
/**
* Add the auth_type parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_auth_type(osip_www_authenticate_t *header, char *value);
/**
* Get value of the realm parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_realm(osip_www_authenticate_t *header);
/**
* Add the realm parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_realm(osip_www_authenticate_t *header, char *value);
/**
* Get value of the domain parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_domain(osip_www_authenticate_t *header);
/**
* Add the domain parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_domain(osip_www_authenticate_t *header, char *value);
/**
* Get value of the nonce parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_nonce(osip_www_authenticate_t *header);
/**
* Add the nonce parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_nonce(osip_www_authenticate_t *header, char *value);
/**
* Get value of the opaque parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_opaque(osip_www_authenticate_t *header);
/**
* Add the opaque parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_opaque(osip_www_authenticate_t *header, char *value);
/**
* Get value of the stale parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_stale(osip_www_authenticate_t *header);
/**
* Add the stale parameter in a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_stale(osip_www_authenticate_t *header, char *value);
/**
* Add a stale parameter set to "true" in a Www-Authenticate element.
* @param header The element to work on.
*/
#define osip_www_authenticate_set_stale_true(header) osip_www_authenticate_set_stale(header, osip_strdup("true"))
/**
* Add a stale parameter set to "false" in a Www-Authenticate element.
* @param header The element to work on.
*/
#define osip_www_authenticate_set_stale_false(header) osip_www_authenticate_set_stale(header, osip_strdup("false"))
/**
* Get value of the algorithm parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_algorithm(osip_www_authenticate_t *header);
/**
* Add the algorithm parameter in a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_algorithm(osip_www_authenticate_t *header, char *value);
/**
* Add the algorithm parameter set to "MD5" in a Www-Authenticate element.
* @param header The element to work on.
*/
#define osip_www_authenticate_set_algorithm_MD5(header) osip_www_authenticate_set_algorithm(header, osip_strdup("MD5"))
/**
* Get value of the qop_options parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_qop_options(osip_www_authenticate_t *header);
/**
* Add the qop_options parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_qop_options(osip_www_authenticate_t *header, char *value);
/**
* Get value of the version parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_version(osip_www_authenticate_t *header);
/**
* Add the version parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_version(osip_www_authenticate_t *header, char *value);
/**
* Get value of the targetname parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_targetname(osip_www_authenticate_t *header);
/**
* Add the targetname parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_targetname(osip_www_authenticate_t *header, char *value);
/**
* Get value of the gssapi_data parameter from a Www-Authenticate element.
* @param header The element to work on.
*/
char *osip_www_authenticate_get_gssapi_data(osip_www_authenticate_t *header);
/**
* Add the gssapi_data parameter from a Www-Authenticate element.
* @param header The element to work on.
* @param value The value of the new parameter.
*/
void osip_www_authenticate_set_gssapi_data(osip_www_authenticate_t *header, char *value);
#ifdef __cplusplus
}
#endif
/** @} */
#endif