2 Unix SMB/CIFS implementation.
4 Connect GENSEC to an external SASL lib
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2006
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/tsocket/tsocket.h"
24 #include "auth/credentials/credentials.h"
25 #include "auth/gensec/gensec.h"
26 #include "auth/gensec/gensec_proto.h"
27 #include "auth/gensec/gensec_toplevel_proto.h"
28 #include <sasl/sasl.h>
30 NTSTATUS
gensec_sasl_init(void);
32 struct gensec_sasl_state
{
38 static NTSTATUS
sasl_nt_status(int sasl_ret
)
42 return NT_STATUS_MORE_PROCESSING_REQUIRED
;
44 return NT_STATUS_NO_MEMORY
;
47 return NT_STATUS_INVALID_PARAMETER
;
49 return NT_STATUS_ACCESS_DENIED
;
53 return NT_STATUS_UNSUCCESSFUL
;
57 static int gensec_sasl_get_user(void *context
, int id
,
58 const char **result
, unsigned *len
)
60 struct gensec_security
*gensec_security
= talloc_get_type(context
, struct gensec_security
);
61 const char *username
= cli_credentials_get_username(gensec_get_credentials(gensec_security
));
62 if (id
!= SASL_CB_USER
&& id
!= SASL_CB_AUTHNAME
) {
70 static int gensec_sasl_get_realm(void *context
, int id
,
71 const char **availrealms
,
74 struct gensec_security
*gensec_security
= talloc_get_type(context
, struct gensec_security
);
75 const char *realm
= cli_credentials_get_realm(gensec_get_credentials(gensec_security
));
77 if (id
!= SASL_CB_GETREALM
) {
81 for (i
=0; availrealms
&& availrealms
[i
]; i
++) {
82 if (strcasecmp_m(realm
, availrealms
[i
]) == 0) {
83 result
[i
] = availrealms
[i
];
87 /* None of the realms match, so lets not specify one */
92 static int gensec_sasl_get_password(sasl_conn_t
*conn
, void *context
, int id
,
93 sasl_secret_t
**psecret
)
95 struct gensec_security
*gensec_security
= talloc_get_type(context
, struct gensec_security
);
96 const char *password
= cli_credentials_get_password(gensec_get_credentials(gensec_security
));
98 sasl_secret_t
*secret
;
103 secret
= talloc_size(gensec_security
, sizeof(sasl_secret_t
)+strlen(password
)+1);
107 secret
->len
= strlen(password
);
108 strlcpy((char*)secret
->data
, password
, secret
->len
+1);
113 static int gensec_sasl_dispose(struct gensec_sasl_state
*gensec_sasl_state
)
115 sasl_dispose(&gensec_sasl_state
->conn
);
119 static NTSTATUS
gensec_sasl_client_start(struct gensec_security
*gensec_security
)
121 struct gensec_sasl_state
*gensec_sasl_state
;
122 const char *service
= gensec_get_target_service(gensec_security
);
123 const char *target_name
= gensec_get_target_hostname(gensec_security
);
124 const struct tsocket_address
*tlocal_addr
= gensec_get_local_address(gensec_security
);
125 const struct tsocket_address
*tremote_addr
= gensec_get_remote_address(gensec_security
);
126 char *local_addr
= NULL
;
127 char *remote_addr
= NULL
;
130 sasl_callback_t
*callbacks
;
132 gensec_sasl_state
= talloc_zero(gensec_security
, struct gensec_sasl_state
);
133 if (!gensec_sasl_state
) {
134 return NT_STATUS_NO_MEMORY
;
137 callbacks
= talloc_array(gensec_sasl_state
, sasl_callback_t
, 5);
138 callbacks
[0].id
= SASL_CB_USER
;
139 callbacks
[0].proc
= gensec_sasl_get_user
;
140 callbacks
[0].context
= gensec_security
;
142 callbacks
[1].id
= SASL_CB_AUTHNAME
;
143 callbacks
[1].proc
= gensec_sasl_get_user
;
144 callbacks
[1].context
= gensec_security
;
146 callbacks
[2].id
= SASL_CB_GETREALM
;
147 callbacks
[2].proc
= gensec_sasl_get_realm
;
148 callbacks
[2].context
= gensec_security
;
150 callbacks
[3].id
= SASL_CB_PASS
;
151 callbacks
[3].proc
= gensec_sasl_get_password
;
152 callbacks
[3].context
= gensec_security
;
154 callbacks
[4].id
= SASL_CB_LIST_END
;
155 callbacks
[4].proc
= NULL
;
156 callbacks
[4].context
= NULL
;
158 gensec_security
->private_data
= gensec_sasl_state
;
161 local_addr
= talloc_asprintf(gensec_sasl_state
,
163 tsocket_address_inet_addr_string(tlocal_addr
, gensec_sasl_state
),
164 tsocket_address_inet_port(tlocal_addr
));
168 remote_addr
= talloc_asprintf(gensec_sasl_state
,
170 tsocket_address_inet_addr_string(tremote_addr
, gensec_sasl_state
),
171 tsocket_address_inet_port(tremote_addr
));
173 gensec_sasl_state
->step
= 0;
175 sasl_ret
= sasl_client_new(service
,
177 local_addr
, remote_addr
, callbacks
, 0,
178 &gensec_sasl_state
->conn
);
180 if (sasl_ret
== SASL_OK
) {
181 sasl_security_properties_t props
;
182 talloc_set_destructor(gensec_sasl_state
, gensec_sasl_dispose
);
185 if (gensec_security
->want_features
& GENSEC_FEATURE_SIGN
) {
188 props
.maxbufsize
= 65536;
189 gensec_sasl_state
->wrap
= true;
191 if (gensec_security
->want_features
& GENSEC_FEATURE_SEAL
) {
193 props
.max_ssf
= UINT_MAX
;
194 props
.maxbufsize
= 65536;
195 gensec_sasl_state
->wrap
= true;
198 sasl_ret
= sasl_setprop(gensec_sasl_state
->conn
, SASL_SEC_PROPS
, &props
);
200 if (sasl_ret
!= SASL_OK
) {
201 DEBUG(1, ("GENSEC SASL: client_new failed: %s\n", sasl_errdetail(gensec_sasl_state
->conn
)));
203 return sasl_nt_status(sasl_ret
);
206 static NTSTATUS
gensec_sasl_update(struct gensec_security
*gensec_security
,
207 TALLOC_CTX
*out_mem_ctx
,
208 struct tevent_context
*ev
,
209 const DATA_BLOB in
, DATA_BLOB
*out
)
211 struct gensec_sasl_state
*gensec_sasl_state
= talloc_get_type(gensec_security
->private_data
,
212 struct gensec_sasl_state
);
214 const char *out_data
;
215 unsigned int out_len
;
217 if (gensec_sasl_state
->step
== 0) {
219 sasl_ret
= sasl_client_start(gensec_sasl_state
->conn
, gensec_security
->ops
->sasl_name
,
220 NULL
, &out_data
, &out_len
, &mech
);
222 sasl_ret
= sasl_client_step(gensec_sasl_state
->conn
,
223 (char*)in
.data
, in
.length
, NULL
,
224 &out_data
, &out_len
);
226 if (sasl_ret
== SASL_OK
|| sasl_ret
== SASL_CONTINUE
) {
227 *out
= data_blob_talloc(out_mem_ctx
, out_data
, out_len
);
229 DEBUG(1, ("GENSEC SASL: step %d update failed: %s\n", gensec_sasl_state
->step
,
230 sasl_errdetail(gensec_sasl_state
->conn
)));
232 gensec_sasl_state
->step
++;
233 return sasl_nt_status(sasl_ret
);
236 static NTSTATUS
gensec_sasl_unwrap_packets(struct gensec_security
*gensec_security
,
237 TALLOC_CTX
*out_mem_ctx
,
240 size_t *len_processed
)
242 struct gensec_sasl_state
*gensec_sasl_state
= talloc_get_type(gensec_security
->private_data
,
243 struct gensec_sasl_state
);
244 const char *out_data
;
245 unsigned int out_len
;
247 int sasl_ret
= sasl_decode(gensec_sasl_state
->conn
,
248 (char*)in
->data
, in
->length
, &out_data
,
250 if (sasl_ret
== SASL_OK
) {
251 *out
= data_blob_talloc(out_mem_ctx
, out_data
, out_len
);
252 *len_processed
= in
->length
;
254 DEBUG(1, ("GENSEC SASL: unwrap failed: %s\n", sasl_errdetail(gensec_sasl_state
->conn
)));
256 return sasl_nt_status(sasl_ret
);
260 static NTSTATUS
gensec_sasl_wrap_packets(struct gensec_security
*gensec_security
,
261 TALLOC_CTX
*out_mem_ctx
,
264 size_t *len_processed
)
266 struct gensec_sasl_state
*gensec_sasl_state
= talloc_get_type(gensec_security
->private_data
,
267 struct gensec_sasl_state
);
268 const char *out_data
;
269 unsigned int out_len
;
270 unsigned len_permitted
;
271 int sasl_ret
= sasl_getprop(gensec_sasl_state
->conn
, SASL_SSF
,
272 (const void**)&len_permitted
);
273 if (sasl_ret
!= SASL_OK
) {
274 return sasl_nt_status(sasl_ret
);
276 len_permitted
= MIN(len_permitted
, in
->length
);
278 sasl_ret
= sasl_encode(gensec_sasl_state
->conn
,
279 (char*)in
->data
, len_permitted
, &out_data
,
281 if (sasl_ret
== SASL_OK
) {
282 *out
= data_blob_talloc(out_mem_ctx
, out_data
, out_len
);
283 *len_processed
= in
->length
;
285 DEBUG(1, ("GENSEC SASL: wrap failed: %s\n", sasl_errdetail(gensec_sasl_state
->conn
)));
287 return sasl_nt_status(sasl_ret
);
290 /* Try to figure out what features we actually got on the connection */
291 static bool gensec_sasl_have_feature(struct gensec_security
*gensec_security
,
294 struct gensec_sasl_state
*gensec_sasl_state
= talloc_get_type(gensec_security
->private_data
,
295 struct gensec_sasl_state
);
299 /* If we did not elect to wrap, then we have neither sign nor seal, no matter what the SSF claims */
300 if (!gensec_sasl_state
->wrap
) {
304 sasl_ret
= sasl_getprop(gensec_sasl_state
->conn
, SASL_SSF
,
306 if (sasl_ret
!= SASL_OK
) {
309 if (feature
& GENSEC_FEATURE_SIGN
) {
317 if (feature
& GENSEC_FEATURE_SEAL
) {
328 /* This could in theory work with any SASL mech */
329 static const struct gensec_security_ops gensec_sasl_security_ops
= {
330 .name
= "sasl-DIGEST-MD5",
331 .sasl_name
= "DIGEST-MD5",
332 .client_start
= gensec_sasl_client_start
,
333 .update
= gensec_sasl_update
,
334 .wrap_packets
= gensec_sasl_wrap_packets
,
335 .unwrap_packets
= gensec_sasl_unwrap_packets
,
336 .have_feature
= gensec_sasl_have_feature
,
338 .priority
= GENSEC_SASL
341 static int gensec_sasl_log(void *context
,
346 switch (sasl_log_level
) {
377 DEBUG(dl
, ("gensec_sasl: %s\n", message
));
382 NTSTATUS
gensec_sasl_init(void)
388 const char **sasl_mechs
;
391 static const sasl_callback_t callbacks
[] = {
394 .proc
= gensec_sasl_log
,
398 .id
= SASL_CB_LIST_END
,
399 .proc
= gensec_sasl_log
,
403 sasl_ret
= sasl_client_init(callbacks
);
405 if (sasl_ret
== SASL_NOMECH
) {
406 /* Nothing to do here */
410 if (sasl_ret
!= SASL_OK
) {
411 return sasl_nt_status(sasl_ret
);
414 /* For now, we just register DIGEST-MD5 */
416 ret
= gensec_register(&gensec_sasl_security_ops
);
417 if (!NT_STATUS_IS_OK(ret
)) {
418 DEBUG(0,("Failed to register '%s' gensec backend!\n",
419 gensec_sasl_security_ops
.name
));
423 sasl_mechs
= sasl_global_listmech();
424 for (i
= 0; sasl_mechs
&& sasl_mechs
[i
]; i
++) {
425 const struct gensec_security_ops
*oldmech
;
426 struct gensec_security_ops
*newmech
;
427 oldmech
= gensec_security_by_sasl_name(NULL
, sasl_mechs
[i
]);
431 newmech
= talloc(talloc_autofree_context(), struct gensec_security_ops
);
433 return NT_STATUS_NO_MEMORY
;
435 *newmech
= gensec_sasl_security_ops
;
436 newmech
->sasl_name
= talloc_strdup(newmech
, sasl_mechs
[i
]);
437 newmech
->name
= talloc_asprintf(newmech
, "sasl-%s", sasl_mechs
[i
]);
438 if (!newmech
->sasl_name
|| !newmech
->name
) {
439 return NT_STATUS_NO_MEMORY
;
442 ret
= gensec_register(newmech
);
443 if (!NT_STATUS_IS_OK(ret
)) {
444 DEBUG(0,("Failed to register '%s' gensec backend!\n",
445 gensec_sasl_security_ops
.name
));