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 <sasl/sasl.h>
29 NTSTATUS gensec_sasl_init(void);
31 struct gensec_sasl_state {
37 static NTSTATUS sasl_nt_status(int sasl_ret)
41 return NT_STATUS_MORE_PROCESSING_REQUIRED;
43 return NT_STATUS_NO_MEMORY;
46 return NT_STATUS_INVALID_PARAMETER;
48 return NT_STATUS_ACCESS_DENIED;
52 return NT_STATUS_UNSUCCESSFUL;
56 static int gensec_sasl_get_user(void *context, int id,
57 const char **result, unsigned *len)
59 struct gensec_security *gensec_security = talloc_get_type(context, struct gensec_security);
60 const char *username = cli_credentials_get_username(gensec_get_credentials(gensec_security));
61 if (id != SASL_CB_USER && id != SASL_CB_AUTHNAME) {
69 static int gensec_sasl_get_realm(void *context, int id,
70 const char **availrealms,
73 struct gensec_security *gensec_security = talloc_get_type(context, struct gensec_security);
74 const char *realm = cli_credentials_get_realm(gensec_get_credentials(gensec_security));
76 if (id != SASL_CB_GETREALM) {
80 for (i=0; availrealms && availrealms[i]; i++) {
81 if (strcasecmp_m(realm, availrealms[i]) == 0) {
82 result[i] = availrealms[i];
86 /* None of the realms match, so lets not specify one */
91 static int gensec_sasl_get_password(sasl_conn_t *conn, void *context, int id,
92 sasl_secret_t **psecret)
94 struct gensec_security *gensec_security = talloc_get_type(context, struct gensec_security);
95 const char *password = cli_credentials_get_password(gensec_get_credentials(gensec_security));
97 sasl_secret_t *secret;
102 secret = talloc_size(gensec_security, sizeof(sasl_secret_t)+strlen(password)+1);
106 secret->len = strlen(password);
107 strlcpy((char*)secret->data, password, secret->len+1);
112 static int gensec_sasl_dispose(struct gensec_sasl_state *gensec_sasl_state)
114 sasl_dispose(&gensec_sasl_state->conn);
118 static NTSTATUS gensec_sasl_client_start(struct gensec_security *gensec_security)
120 struct gensec_sasl_state *gensec_sasl_state;
121 const char *service = gensec_get_target_service(gensec_security);
122 const char *target_name = gensec_get_target_hostname(gensec_security);
123 const struct tsocket_address *tlocal_addr = gensec_get_local_address(gensec_security);
124 const struct tsocket_address *tremote_addr = gensec_get_remote_address(gensec_security);
125 char *local_addr = NULL;
126 char *remote_addr = NULL;
129 sasl_callback_t *callbacks;
131 gensec_sasl_state = talloc_zero(gensec_security, struct gensec_sasl_state);
132 if (!gensec_sasl_state) {
133 return NT_STATUS_NO_MEMORY;
136 callbacks = talloc_array(gensec_sasl_state, sasl_callback_t, 5);
137 callbacks[0].id = SASL_CB_USER;
138 callbacks[0].proc = gensec_sasl_get_user;
139 callbacks[0].context = gensec_security;
141 callbacks[1].id = SASL_CB_AUTHNAME;
142 callbacks[1].proc = gensec_sasl_get_user;
143 callbacks[1].context = gensec_security;
145 callbacks[2].id = SASL_CB_GETREALM;
146 callbacks[2].proc = gensec_sasl_get_realm;
147 callbacks[2].context = gensec_security;
149 callbacks[3].id = SASL_CB_PASS;
150 callbacks[3].proc = gensec_sasl_get_password;
151 callbacks[3].context = gensec_security;
153 callbacks[4].id = SASL_CB_LIST_END;
154 callbacks[4].proc = NULL;
155 callbacks[4].context = NULL;
157 gensec_security->private_data = gensec_sasl_state;
160 local_addr = talloc_asprintf(gensec_sasl_state,
162 tsocket_address_inet_addr_string(tlocal_addr, gensec_sasl_state),
163 tsocket_address_inet_port(tlocal_addr));
167 remote_addr = talloc_asprintf(gensec_sasl_state,
169 tsocket_address_inet_addr_string(tremote_addr, gensec_sasl_state),
170 tsocket_address_inet_port(tremote_addr));
172 gensec_sasl_state->step = 0;
174 sasl_ret = sasl_client_new(service,
176 local_addr, remote_addr, callbacks, 0,
177 &gensec_sasl_state->conn);
179 if (sasl_ret == SASL_OK) {
180 sasl_security_properties_t props;
181 talloc_set_destructor(gensec_sasl_state, gensec_sasl_dispose);
184 if (gensec_security->want_features & GENSEC_FEATURE_SIGN) {
187 props.maxbufsize = 65536;
188 gensec_sasl_state->wrap = true;
190 if (gensec_security->want_features & GENSEC_FEATURE_SEAL) {
192 props.max_ssf = UINT_MAX;
193 props.maxbufsize = 65536;
194 gensec_sasl_state->wrap = true;
197 sasl_ret = sasl_setprop(gensec_sasl_state->conn, SASL_SEC_PROPS, &props);
199 if (sasl_ret != SASL_OK) {
200 DEBUG(1, ("GENSEC SASL: client_new failed: %s\n", sasl_errdetail(gensec_sasl_state->conn)));
202 return sasl_nt_status(sasl_ret);
205 static NTSTATUS gensec_sasl_update(struct gensec_security *gensec_security,
206 TALLOC_CTX *out_mem_ctx,
207 const DATA_BLOB in, DATA_BLOB *out)
209 struct gensec_sasl_state *gensec_sasl_state = talloc_get_type(gensec_security->private_data,
210 struct gensec_sasl_state);
212 const char *out_data;
213 unsigned int out_len;
215 if (gensec_sasl_state->step == 0) {
217 sasl_ret = sasl_client_start(gensec_sasl_state->conn, gensec_security->ops->sasl_name,
218 NULL, &out_data, &out_len, &mech);
220 sasl_ret = sasl_client_step(gensec_sasl_state->conn,
221 (char*)in.data, in.length, NULL,
222 &out_data, &out_len);
224 if (sasl_ret == SASL_OK || sasl_ret == SASL_CONTINUE) {
225 *out = data_blob_talloc(out_mem_ctx, out_data, out_len);
227 DEBUG(1, ("GENSEC SASL: step %d update failed: %s\n", gensec_sasl_state->step,
228 sasl_errdetail(gensec_sasl_state->conn)));
230 gensec_sasl_state->step++;
231 return sasl_nt_status(sasl_ret);
234 static NTSTATUS gensec_sasl_unwrap_packets(struct gensec_security *gensec_security,
235 TALLOC_CTX *out_mem_ctx,
238 size_t *len_processed)
240 struct gensec_sasl_state *gensec_sasl_state = talloc_get_type(gensec_security->private_data,
241 struct gensec_sasl_state);
242 const char *out_data;
243 unsigned int out_len;
245 int sasl_ret = sasl_decode(gensec_sasl_state->conn,
246 (char*)in->data, in->length, &out_data,
248 if (sasl_ret == SASL_OK) {
249 *out = data_blob_talloc(out_mem_ctx, out_data, out_len);
250 *len_processed = in->length;
252 DEBUG(1, ("GENSEC SASL: unwrap failed: %s\n", sasl_errdetail(gensec_sasl_state->conn)));
254 return sasl_nt_status(sasl_ret);
258 static NTSTATUS gensec_sasl_wrap_packets(struct gensec_security *gensec_security,
259 TALLOC_CTX *out_mem_ctx,
262 size_t *len_processed)
264 struct gensec_sasl_state *gensec_sasl_state = talloc_get_type(gensec_security->private_data,
265 struct gensec_sasl_state);
266 const char *out_data;
267 unsigned int out_len;
268 unsigned len_permitted;
269 int sasl_ret = sasl_getprop(gensec_sasl_state->conn, SASL_SSF,
270 (const void**)&len_permitted);
271 if (sasl_ret != SASL_OK) {
272 return sasl_nt_status(sasl_ret);
274 len_permitted = MIN(len_permitted, in->length);
276 sasl_ret = sasl_encode(gensec_sasl_state->conn,
277 (char*)in->data, len_permitted, &out_data,
279 if (sasl_ret == SASL_OK) {
280 *out = data_blob_talloc(out_mem_ctx, out_data, out_len);
281 *len_processed = in->length;
283 DEBUG(1, ("GENSEC SASL: wrap failed: %s\n", sasl_errdetail(gensec_sasl_state->conn)));
285 return sasl_nt_status(sasl_ret);
288 /* Try to figure out what features we actually got on the connection */
289 static bool gensec_sasl_have_feature(struct gensec_security *gensec_security,
292 struct gensec_sasl_state *gensec_sasl_state = talloc_get_type(gensec_security->private_data,
293 struct gensec_sasl_state);
297 /* If we did not elect to wrap, then we have neither sign nor seal, no matter what the SSF claims */
298 if (!gensec_sasl_state->wrap) {
302 sasl_ret = sasl_getprop(gensec_sasl_state->conn, SASL_SSF,
304 if (sasl_ret != SASL_OK) {
307 if (feature & GENSEC_FEATURE_SIGN) {
315 if (feature & GENSEC_FEATURE_SEAL) {
326 /* This could in theory work with any SASL mech */
327 static const struct gensec_security_ops gensec_sasl_security_ops = {
328 .name = "sasl-DIGEST-MD5",
329 .sasl_name = "DIGEST-MD5",
330 .client_start = gensec_sasl_client_start,
331 .update = gensec_sasl_update,
332 .wrap_packets = gensec_sasl_wrap_packets,
333 .unwrap_packets = gensec_sasl_unwrap_packets,
334 .have_feature = gensec_sasl_have_feature,
336 .priority = GENSEC_SASL
339 static int gensec_sasl_log(void *context,
344 switch (sasl_log_level) {
375 DEBUG(dl, ("gensec_sasl: %s\n", message));
380 NTSTATUS gensec_sasl_init(void)
386 const char **sasl_mechs;
389 static const sasl_callback_t callbacks[] = {
392 .proc = gensec_sasl_log,
396 .id = SASL_CB_LIST_END,
397 .proc = gensec_sasl_log,
401 sasl_ret = sasl_client_init(callbacks);
403 if (sasl_ret == SASL_NOMECH) {
404 /* Nothing to do here */
408 if (sasl_ret != SASL_OK) {
409 return sasl_nt_status(sasl_ret);
412 /* For now, we just register DIGEST-MD5 */
414 ret = gensec_register(&gensec_sasl_security_ops);
415 if (!NT_STATUS_IS_OK(ret)) {
416 DEBUG(0,("Failed to register '%s' gensec backend!\n",
417 gensec_sasl_security_ops.name));
421 sasl_mechs = sasl_global_listmech();
422 for (i = 0; sasl_mechs && sasl_mechs[i]; i++) {
423 const struct gensec_security_ops *oldmech;
424 struct gensec_security_ops *newmech;
425 oldmech = gensec_security_by_sasl_name(NULL, sasl_mechs[i]);
429 newmech = talloc(talloc_autofree_context(), struct gensec_security_ops);
431 return NT_STATUS_NO_MEMORY;
433 *newmech = gensec_sasl_security_ops;
434 newmech->sasl_name = talloc_strdup(newmech, sasl_mechs[i]);
435 newmech->name = talloc_asprintf(newmech, "sasl-%s", sasl_mechs[i]);
436 if (!newmech->sasl_name || !newmech->name) {
437 return NT_STATUS_NO_MEMORY;
440 ret = gensec_register(newmech);
441 if (!NT_STATUS_IS_OK(ret)) {
442 DEBUG(0,("Failed to register '%s' gensec backend!\n",
443 gensec_sasl_security_ops.name));