imap_gssapi.h

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Implementation of IMAP GSSAPI authentication according to RFC 1731.
   3  *@ TODO GSSAPI should also be joined into "a VFS".  TODO LEAKS (error path)
   4  *
   5  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   6  * Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
   7  */
   8 /*
   9  * Copyright (c) 2004 Gunnar Ritter.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  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.
  27  *
  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
  38  * SUCH DAMAGE.
  39  */
  40
  41 /*
  42  * Partially derived from sample code in:
  43  *
  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.
  47  *
  48  * (c) 2002 Sun Microsystems
  49  */
  50 /*
  51  * Copyright 1994 by OpenVision Technologies, Inc.
  52  *
  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.
  62  *
  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.
  70  */
  71
  72 #ifdef HAVE_GSSAPI
  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
  78 # endif
  79 #else
  80 # include <gssapi.h>
  81 #endif
  82
  83 static void imap_gss_error1(const char *s, OM_uint32 code, int typ);
  84 static void imap_gss_error(const char *s, OM_uint32 maj_stat,
  85                OM_uint32 min_stat);
  86
  87 static void
  88 imap_gss_error1(const char *s, OM_uint32 code, int typ)
  89 {
  90    OM_uint32 maj_stat, min_stat;
  91    gss_buffer_desc msg = GSS_C_EMPTY_BUFFER;
  92    OM_uint32 msg_ctx = 0;
  93    NYD_ENTER;
  94
  95    do {
  96       maj_stat = gss_display_status(&min_stat, code, typ, GSS_C_NO_OID,
  97             &msg_ctx, &msg);
  98       if (maj_stat == GSS_S_COMPLETE) {
  99          fprintf(stderr, "GSS error: %s / %s\n", s, (char*)msg.value);
 100          if (msg.length != 0)
 101             gss_release_buffer(&min_stat, &msg);
 102       } else {
 103          fprintf(stderr, "GSS error: %s / unknown\n", s);
 104          break;
 105       }
 106    } while (msg_ctx);
 107    NYD_LEAVE;
 108 }
 109
 110 static void
 111 imap_gss_error(const char *s, OM_uint32 maj_stat, OM_uint32 min_stat)
 112 {
 113    NYD_ENTER;
 114    imap_gss_error1(s, maj_stat, GSS_C_GSS_CODE);
 115    imap_gss_error1(s, min_stat, GSS_C_MECH_CODE);
 116    NYD_LEAVE;
 117 }
 118
 119 static enum okay
 120 imap_gss(struct mailbox *mp, char *user)
 121 {
 122    char o[LINESIZE];
 123    struct str in, out;
 124    gss_buffer_desc send_tok, recv_tok, *token_ptr;
 125    gss_name_t target_name;
 126    gss_ctx_id_t gss_context;
 127    OM_uint32 maj_stat, min_stat, ret_flags;
 128    int conf_state;
 129    FILE *queuefp = NULL;
 130    char *server, *cp;
 131    enum okay ok = STOP;
 132    NYD_X;
 133
 134    if (user == NULL) {
 135       if ((user = getuser(NULL)) == NULL)
 136          return STOP;
 137       user = savestr(user);
 138    }
 139    {  size_t i = strlen(mp->mb_imap_account) +1;
 140       server = salloc(i);
 141       memcpy(server, mp->mb_imap_account, i);
 142    }
 143    if (!strncmp(server, "imap://", 7))
 144       server += 7;
 145    else if (!strncmp(server, "imaps://", 8))
 146       server += 8;
 147    if ((cp = UNCONST(last_at_before_slash(server))) != NULL)
 148       server = &cp[1];
 149    for (cp = server; *cp; cp++)
 150       *cp = lowerconv(*cp);
 151    send_tok.value = salloc(send_tok.length = strlen(server) + 6);
 152    snprintf(send_tok.value, send_tok.length, "imap@%s", server);
 153    maj_stat = gss_import_name(&min_stat, &send_tok, GSS_C_NT_HOSTBASED_SERVICE,
 154          &target_name);
 155    if (maj_stat != GSS_S_COMPLETE) {
 156       imap_gss_error(send_tok.value, maj_stat, min_stat);
 157       return STOP;
 158    }
 159    token_ptr = GSS_C_NO_BUFFER;
 160    gss_context = GSS_C_NO_CONTEXT;
 161    maj_stat = gss_init_sec_context(&min_stat,
 162          GSS_C_NO_CREDENTIAL,
 163          &gss_context,
 164          target_name,
 165          GSS_C_NO_OID,
 166          GSS_C_MUTUAL_FLAG|GSS_C_SEQUENCE_FLAG,
 167          0,
 168          GSS_C_NO_CHANNEL_BINDINGS,
 169          token_ptr,
 170          NULL,
 171          &send_tok,
 172          &ret_flags,
 173          NULL);
 174    if (maj_stat != GSS_S_COMPLETE && maj_stat != GSS_S_CONTINUE_NEEDED) {
 175       imap_gss_error("initializing GSS context", maj_stat, min_stat);
 176       gss_release_name(&min_stat, &target_name);
 177       return STOP;
 178    }
 179    snprintf(o, sizeof o, "%s AUTHENTICATE GSSAPI\r\n", tag(1));
 180    IMAP_OUT(o, 0, return STOP);
 181    /*
 182     * No response data expected.
 183     */
 184    imap_answer(mp, 1);
 185    if (response_type != RESPONSE_CONT)
 186       return STOP;
 187    while (maj_stat == GSS_S_CONTINUE_NEEDED) {
 188       /*
 189        * Pass token obtained from first gss_init_sec_context() call.
 190        */
 191       b64_encode_buf(&out, send_tok.value, send_tok.length,
 192          B64_SALLOC | B64_CRLF);
 193       gss_release_buffer(&min_stat, &send_tok);
 194       IMAP_OUT(out.s, 0, return STOP);
 195       imap_answer(mp, 1);
 196       if (response_type != RESPONSE_CONT)
 197          return STOP;
 198       out.s = NULL;
 199       in.s = responded_text;
 200       in.l = strlen(responded_text);
 201       b64_decode(&out, &in, NULL);
 202       recv_tok.value = out.s;
 203       recv_tok.length = out.l;
 204       token_ptr = &recv_tok;
 205       maj_stat = gss_init_sec_context(&min_stat,
 206             GSS_C_NO_CREDENTIAL,
 207             &gss_context,
 208             target_name,
 209             GSS_C_NO_OID,
 210             GSS_C_MUTUAL_FLAG|GSS_C_SEQUENCE_FLAG,
 211             0,
 212             GSS_C_NO_CHANNEL_BINDINGS,
 213             token_ptr,
 214             NULL,
 215             &send_tok,
 216             &ret_flags,
 217             NULL);
 218       free(out.s);
 219       if (maj_stat != GSS_S_COMPLETE && maj_stat != GSS_S_CONTINUE_NEEDED) {
 220          imap_gss_error("initializing context", maj_stat, min_stat);
 221          gss_release_name(&min_stat, &target_name);
 222          return STOP;
 223       }
 224    }
 225    /*
 226     * Pass token obtained from second gss_init_sec_context() call.
 227     */
 228    gss_release_name(&min_stat, &target_name);
 229    b64_encode_buf(&out, send_tok.value, send_tok.length, B64_SALLOC | B64_CRLF);
 230    gss_release_buffer(&min_stat, &send_tok);
 231    IMAP_OUT(out.s, 0, return STOP);
 232    /*
 233     * First octet: bit-mask with protection mechanisms.
 234     * Second to fourth octet: maximum message size in network byte order.
 235     *
 236     * This code currently does not care about the values.
 237     */
 238    imap_answer(mp, 1);
 239    if (response_type != RESPONSE_CONT)
 240       return STOP;
 241    out.s = NULL;
 242    in.s = responded_text;
 243    in.l = strlen(responded_text);
 244    b64_decode(&out, &in, NULL);
 245    recv_tok.value = out.s;
 246    recv_tok.length = out.l;
 247    maj_stat = gss_unwrap(&min_stat, gss_context, &recv_tok, &send_tok,
 248          &conf_state, NULL);
 249    free(out.s);
 250    if (maj_stat != GSS_S_COMPLETE) {
 251       imap_gss_error("unwrapping data", maj_stat, min_stat);
 252       return STOP;
 253    }
 254    /*
 255     * First octet: bit-mask with protection mechanisms (1 = no protection
 256     *    mechanism).
 257     * Second to fourth octet: maximum message size in network byte order.
 258     * Fifth and following octets: user name string.
 259     */
 260    o[0] = 1;
 261    o[1] = 0;
 262    o[2] = o[3] = (char)0377;
 263    snprintf(&o[4], sizeof o - 4, "%s", user);
 264    send_tok.value = o;
 265    send_tok.length = strlen(&o[4]) + 5;
 266    maj_stat = gss_wrap(&min_stat, gss_context, 0, GSS_C_QOP_DEFAULT, &send_tok,
 267          &conf_state, &recv_tok);
 268    if (maj_stat != GSS_S_COMPLETE) {
 269       imap_gss_error("wrapping data", maj_stat, min_stat);
 270       return STOP;
 271    }
 272    b64_encode_buf(&out, recv_tok.value, recv_tok.length, B64_SALLOC | B64_CRLF);
 273    IMAP_OUT(out.s, MB_COMD, return STOP);
 274    while (mp->mb_active & MB_COMD)
 275       ok = imap_answer(mp, 1);
 276    gss_delete_sec_context(&min_stat, &gss_context, &recv_tok);
 277    gss_release_buffer(&min_stat, &recv_tok);
 278    return ok;
 279 }
 280
 281 # undef GSS_C_NT_HOSTBASED_SERVICE
 282 #endif /* HAVE_GSSAPI */
 283
 284 /* vim:set fenc=utf-8:s-it-mode */