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
|
/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef AXIS2_NTLM_H
#define AXIS2_NTLM_H
/**
*@file axis2_ntlm.h
*@brief this is the ntlm authentication abstraction layer for axis2
*/
#include <axutil_env.h>
#include <axutil_utils.h>
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct axis2_ntlm_ops axis2_ntlm_ops_t;
typedef struct axis2_ntlm axis2_ntlm_t;
/**
* @defgroup axis2_ntlm ntlm
* @ingroup axiom
* @{
* @}
*/
/**
* @defgroup axis2_ntlm ntlm
* @ingroup axis2_ntlm
* @{
*/
/**
* \brief AXIS2_NTLM ops
* Encapsulator struct for ops of axiis2_ntlm
*/
struct axis2_ntlm_ops
{
/**
* free pull_ntlm
* @param ntlm axis2_ntlm struct
* @param env axutil_environment MUST NOT be NULL
* @returns axis2_status_code
*/
void (
AXIS2_CALL
* free)(
axis2_ntlm_t * ntlm,
const axutil_env_t * env);
/**
* Create Type1 NTLM message. This will create a type1 message and assign
* it to the return type.
* @param ntlm axis2_ntlm
* @param env axutil_environment, MUST NOT be NULL.
* @param encoded_message return type passed by caller.
* @param encoded_len length of the encoded message
* @param uname user name
* @param passwd password
* @param flags NTLM flags
* @param domain domain
* @param workstation
* @returns status , AXIS2_FAILURE on error
*/
axis2_status_t (
AXIS2_CALL
* create_type1_message)(
axis2_ntlm_t * ntlm,
const axutil_env_t * env,
axis2_char_t **encoded_message,
int *encoded_len,
const axis2_char_t *uname,
const axis2_char_t *passwd,
const int flags,
const axis2_char_t *domain);
/**
* Create Type3 NTLM message. This will create a type3 message and assign
* it to the return type.
* @param ntlm axis2_ntlm
* @param env axutil_environment, MUST NOT be NULL.
* @param header_value Header value extracted from the type2 message
* @param encoded_message return type passed by caller.
* @param encoded_len length of the encoded message
* @param uname user name
* @param passwd password
* @param flags NTLM flags
* @param domain domain
* @param workstation
* @returns status , AXIS2_FAILURE on error
*/
axis2_status_t(
AXIS2_CALL
* create_type3_message)(
axis2_ntlm_t * ntlm,
const axutil_env_t * env,
axis2_char_t *header_value,
axis2_char_t **encoded_message,
int *encoded_len,
const axis2_char_t *uname,
const axis2_char_t *passwd,
const axis2_char_t *domain,
const axis2_char_t *workstation);
};
/**
* @brief axis2_ntlm struct
* Axis2 NTLM
*/
struct axis2_ntlm
{
const axis2_ntlm_ops_t *ops;
};
/**
* Creates an instance of axis2_ntlm that would be used to
* authorize NTLM
* @param env environment struct, must not be null
* @returns a pointer to axis2_ntlm_t struct
* NULL on error with error code set in the environment's error
*/
AXIS2_EXTERN axis2_ntlm_t *AXIS2_CALL
axis2_ntlm_create(
const axutil_env_t * env);
/**
* free method for ntlm
* @param ntlm pointer to the NTLM struct
* @param env environment struct, must not be null
*
* @return
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_ntlm_free(
axis2_ntlm_t * ntlm,
const axutil_env_t * env);
/**
* Create Type1 NTLM message. This will create a type1 message and assign
* it to the return type.
* @param ntlm axis2_ntlm
* @param env axutil_environment, MUST NOT be NULL.
* @param encoded_message return type passed by caller.
* @param encoded_len length of the encoded message
* @param uname user name
* @param passwd password
* @param flags NTLM flags
* @param domain domain
* @param workstation
* @returns status , AXIS2_FAILURE on error
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_ntlm_auth_create_type1_message(
axis2_ntlm_t * ntlm,
const axutil_env_t * env,
axis2_char_t **encoded_message,
int *encoded_len,
const axis2_char_t *uname,
const axis2_char_t *passwd,
const int flags,
const axis2_char_t *domain);
/**
* Create Type3 NTLM message. This will create a type3 message and assign
* it to the return type.
* @param ntlm axis2_ntlm
* @param env axutil_environment, MUST NOT be NULL.
* @param header_value Header value extracted from the type2 message
* @param encoded_message return type passed by caller.
* @param encoded_len length of the encoded message
* @param uname user name
* @param passwd password
* @param flags NTLM flags
* @param domain domain
* @param workstation
* @returns status , AXIS2_FAILURE on error
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_ntlm_auth_create_type3_message(
axis2_ntlm_t * ntlm,
const axutil_env_t * env,
axis2_char_t *header_value,
axis2_char_t **encoded_message,
int *encoded_len,
const axis2_char_t *uname,
const axis2_char_t *passwd,
const axis2_char_t *domain,
const axis2_char_t *workstation);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_NTLM_H */
|
