1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Implementation of IMAP GSS-API authentication according to RFC 1731.
3 *@ TODO GSS-API should also be joined into "a VFS". TODO LEAKS (error path)
5 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
6 * Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
9 * Copyright (c) 2004 Gunnar Ritter.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by Gunnar Ritter
23 * and his contributors.
24 * 4. Neither the name of Gunnar Ritter nor the names of his contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY GUNNAR RITTER AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL GUNNAR RITTER OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 * Partially derived from sample code in:
44 * GSS-API Programming Guide
45 * Part No: 816-1331-11
46 * Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A.
48 * (c) 2002 Sun Microsystems
51 * Copyright 1994 by OpenVision Technologies, Inc.
53 * Permission to use, copy, modify, distribute, and sell this software
54 * and its documentation for any purpose is hereby granted without fee,
55 * provided that the above copyright notice appears in all copies and
56 * that both that copyright notice and this permission notice appear in
57 * supporting documentation, and that the name of OpenVision not be used
58 * in advertising or publicity pertaining to distribution of the software
59 * without specific, written prior permission. OpenVision makes no
60 * representations about the suitability of this software for any
61 * purpose. It is provided "as is" without express or implied warranty.
63 * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
64 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
65 * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
66 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
67 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
68 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
69 * PERFORMANCE OF THIS SOFTWARE.
73 #ifndef GSSAPI_REG_INCLUDE
74 # include <gssapi/gssapi.h>
75 # ifdef GSSAPI_OLD_STYLE
76 # include <gssapi/gssapi_generic.h>
77 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
83 static void _imap_gssapi_error1(const char *s
, OM_uint32 code
, int typ
);
84 static void _imap_gssapi_error(const char *s
, OM_uint32 maj_stat
,
86 static char * _imap_gssapi_last_at_before_slash(char const *sp
);
89 _imap_gssapi_error1(const char *s
, OM_uint32 code
, int typ
)
91 OM_uint32 maj_stat
, min_stat
;
92 gss_buffer_desc msg
= GSS_C_EMPTY_BUFFER
;
93 OM_uint32 msg_ctx
= 0;
97 maj_stat
= gss_display_status(&min_stat
, code
, typ
, GSS_C_NO_OID
,
99 if (maj_stat
== GSS_S_COMPLETE
) {
100 fprintf(stderr
, "GSS error: %s / %s\n", s
, (char*)msg
.value
);
102 gss_release_buffer(&min_stat
, &msg
);
104 fprintf(stderr
, "GSS error: %s / unknown\n", s
);
112 _imap_gssapi_error(const char *s
, OM_uint32 maj_stat
, OM_uint32 min_stat
)
115 _imap_gssapi_error1(s
, maj_stat
, GSS_C_GSS_CODE
);
116 _imap_gssapi_error1(s
, min_stat
, GSS_C_MECH_CODE
);
121 _imap_gssapi_last_at_before_slash(char const *sp
)
127 for (cp
= sp
; (c
= *cp
) != '\0'; ++cp
)
130 while (cp
> sp
&& *--cp
!= '@')
139 _imap_gssapi(struct mailbox
*mp
, struct ccred
*ccred
)
143 gss_buffer_desc send_tok
, recv_tok
, *token_ptr
;
144 gss_name_t target_name
;
145 gss_ctx_id_t gss_context
;
146 OM_uint32 maj_stat
, min_stat
, ret_flags
;
148 FILE *queuefp
= NULL
;
153 { size_t i
= strlen(mp
->mb_imap_account
) +1;
155 memcpy(server
, mp
->mb_imap_account
, i
);
157 if (!strncmp(server
, "imap://", 7))
159 else if (!strncmp(server
, "imaps://", 8))
161 if ((cp
= _imap_gssapi_last_at_before_slash(server
)) != NULL
)
163 for (cp
= server
; *cp
; cp
++)
164 *cp
= lowerconv(*cp
);
165 send_tok
.value
= salloc(send_tok
.length
= strlen(server
) + 6);
166 snprintf(send_tok
.value
, send_tok
.length
, "imap@%s", server
);
167 maj_stat
= gss_import_name(&min_stat
, &send_tok
, GSS_C_NT_HOSTBASED_SERVICE
,
169 if (maj_stat
!= GSS_S_COMPLETE
) {
170 _imap_gssapi_error(send_tok
.value
, maj_stat
, min_stat
);
173 token_ptr
= GSS_C_NO_BUFFER
;
174 gss_context
= GSS_C_NO_CONTEXT
;
175 maj_stat
= gss_init_sec_context(&min_stat
,
180 GSS_C_MUTUAL_FLAG
|GSS_C_SEQUENCE_FLAG
,
182 GSS_C_NO_CHANNEL_BINDINGS
,
188 if (maj_stat
!= GSS_S_COMPLETE
&& maj_stat
!= GSS_S_CONTINUE_NEEDED
) {
189 _imap_gssapi_error("initializing GSS context", maj_stat
, min_stat
);
190 gss_release_name(&min_stat
, &target_name
);
193 snprintf(o
, sizeof o
, "%s AUTHENTICATE GSSAPI\r\n", tag(1));
194 IMAP_OUT(o
, 0, return STOP
);
196 * No response data expected.
199 if (response_type
!= RESPONSE_CONT
)
201 while (maj_stat
== GSS_S_CONTINUE_NEEDED
) {
203 * Pass token obtained from first gss_init_sec_context() call.
205 b64_encode_buf(&out
, send_tok
.value
, send_tok
.length
,
206 B64_SALLOC
| B64_CRLF
);
207 gss_release_buffer(&min_stat
, &send_tok
);
208 IMAP_OUT(out
.s
, 0, return STOP
);
210 if (response_type
!= RESPONSE_CONT
)
213 in
.s
= responded_text
;
214 in
.l
= strlen(responded_text
);
215 b64_decode(&out
, &in
, NULL
);
216 recv_tok
.value
= out
.s
;
217 recv_tok
.length
= out
.l
;
218 token_ptr
= &recv_tok
;
219 maj_stat
= gss_init_sec_context(&min_stat
,
224 GSS_C_MUTUAL_FLAG
|GSS_C_SEQUENCE_FLAG
,
226 GSS_C_NO_CHANNEL_BINDINGS
,
233 if (maj_stat
!= GSS_S_COMPLETE
&& maj_stat
!= GSS_S_CONTINUE_NEEDED
) {
234 _imap_gssapi_error("initializing context", maj_stat
, min_stat
);
235 gss_release_name(&min_stat
, &target_name
);
240 * Pass token obtained from second gss_init_sec_context() call.
242 gss_release_name(&min_stat
, &target_name
);
243 b64_encode_buf(&out
, send_tok
.value
, send_tok
.length
, B64_SALLOC
| B64_CRLF
);
244 gss_release_buffer(&min_stat
, &send_tok
);
245 IMAP_OUT(out
.s
, 0, return STOP
);
247 * First octet: bit-mask with protection mechanisms.
248 * Second to fourth octet: maximum message size in network byte order.
250 * This code currently does not care about the values.
253 if (response_type
!= RESPONSE_CONT
)
256 in
.s
= responded_text
;
257 in
.l
= strlen(responded_text
);
258 b64_decode(&out
, &in
, NULL
);
259 recv_tok
.value
= out
.s
;
260 recv_tok
.length
= out
.l
;
261 maj_stat
= gss_unwrap(&min_stat
, gss_context
, &recv_tok
, &send_tok
,
264 if (maj_stat
!= GSS_S_COMPLETE
) {
265 _imap_gssapi_error("unwrapping data", maj_stat
, min_stat
);
269 * First octet: bit-mask with protection mechanisms (1 = no protection
271 * Second to fourth octet: maximum message size in network byte order.
272 * Fifth and following octets: user name string.
276 o
[2] = o
[3] = (char)0377;
277 snprintf(&o
[4], sizeof o
- 4, "%s", ccred
->cc_user
.s
);
279 send_tok
.length
= strlen(&o
[4]) + 5;
280 maj_stat
= gss_wrap(&min_stat
, gss_context
, 0, GSS_C_QOP_DEFAULT
, &send_tok
,
281 &conf_state
, &recv_tok
);
282 if (maj_stat
!= GSS_S_COMPLETE
) {
283 _imap_gssapi_error("wrapping data", maj_stat
, min_stat
);
286 b64_encode_buf(&out
, recv_tok
.value
, recv_tok
.length
, B64_SALLOC
| B64_CRLF
);
287 IMAP_OUT(out
.s
, MB_COMD
, return STOP
);
288 while (mp
->mb_active
& MB_COMD
)
289 ok
= imap_answer(mp
, 1);
290 gss_delete_sec_context(&min_stat
, &gss_context
, &recv_tok
);
291 gss_release_buffer(&min_stat
, &recv_tok
);
295 # undef GSS_C_NT_HOSTBASED_SERVICE
296 #endif /* HAVE_GSSAPI */