gsscon/gsscon_active.c

   1 /*
   2  * Copyright (c) 2012, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * This code was adapted from the MIT Kerberos Consortium's
  34  * GSS example code, which was distributed under the following
  35  * license:
  36  *
  37  * Copyright 2004-2006 Massachusetts Institute of Technology.
  38  * All Rights Reserved.
  39  *
  40  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  41  * distribute this software and its documentation for any purpose and
  42  * without fee is hereby granted, provided that the above copyright
  43  * notice appear in all copies and that both that copyright notice and
  44  * this permission notice appear in supporting documentation, and that
  45  * the name of M.I.T. not be used in advertising or publicity pertaining
  46  * to distribution of the software without specific, written prior
  47  * permission.  Furthermore if you modify this software you must label
  48  * your software as modified software and not distribute it in such a
  49  * fashion that it might be confused with the original M.I.T. software.
  50  * M.I.T. makes no representations about the suitability of
  51  * this software for any purpose.  It is provided "as is" without express
  52  * or implied warranty.
  53  */
  54
  55 #include <stdio.h>
  56 #include <stdlib.h>
  57 #include <netdb.h>
  58
  59 #include <gsscon.h>
  60
  61 /* ---------------------------------------------------------------------------
  62 */
  63
  64 int gsscon_connect (const char *inHost, unsigned int inPort, const char *inServiceName, int *outFD, gss_ctx_id_t *outGSSContext)
  65 {
  66     int err = 0;
  67     int fd = -1;
  68     OM_uint32 majorStatus;
  69     OM_uint32 minorStatus = 0, minorStatusToo = 0;
  70     struct hostent *hp = NULL;
  71     struct sockaddr_in saddr;
  72     gss_name_t serviceName = NULL;
  73     gss_name_t clientName = NULL;
  74     gss_cred_id_t clientCredentials = GSS_C_NO_CREDENTIAL;
  75     gss_ctx_id_t gssContext = GSS_C_NO_CONTEXT;
  76     OM_uint32 actualFlags = 0;
  77     char *inputTokenBuffer = NULL;
  78     size_t inputTokenBufferLength = 0;
  79     gss_buffer_desc inputToken;  /* buffer received from the server */
  80     gss_buffer_desc nameBuffer;
  81     gss_buffer_t inputTokenPtr = GSS_C_NO_BUFFER;
  82     char *name;
  83
  84     if (!inServiceName) { err = EINVAL; }
  85     if (!outGSSContext) { err = EINVAL; }
  86
  87     if (!err) {
  88         hp = gethostbyname (inHost);
  89         if (hp == NULL) { err = h_errno; }
  90     }
  91
  92     if (!err) {
  93         saddr.sin_family = hp->h_addrtype;
  94         memcpy ((char *) &saddr.sin_addr, hp->h_addr, sizeof (saddr.sin_addr));
  95         saddr.sin_port = htons(inPort);
  96
  97         fd = socket (AF_INET, SOCK_STREAM, 0);
  98         if (fd < 0) { err = errno; }
  99     }
 100
 101     if (!err) {
 102         fprintf (stderr, "gss_connect: Connecting to host '%s' on port %d\n", inHost, inPort);
 103         err = connect (fd, (struct sockaddr *) &saddr, sizeof (saddr));
 104         if (err < 0) { err = errno; }
 105     }
 106
 107     if (!err) {
 108         *outFD = fd;
 109         fd = -1; /* takes ownership */
 110     } else {
 111         gsscon_print_error (err, "OpenConnection failed");
 112     }
 113
 114     if (fd >= 0) { close (fd); }
 115
 116     if (!err) {
 117       majorStatus = gss_acquire_cred (&minorStatus, clientName, GSS_C_INDEFINITE, GSS_C_NO_OID_SET,
 118                                                 GSS_C_INITIATE, &clientCredentials, NULL, NULL);
 119       if (majorStatus != GSS_S_COMPLETE) {
 120         gsscon_print_gss_errors ("gss_acquire_cred", majorStatus, minorStatus);
 121         err = minorStatus ? minorStatus : majorStatus;
 122       }
 123     }
 124
 125     /*
 126      * Here is where the client picks the service principal it will
 127      * try to use to connect to the server.  In the case of the
 128      * gssClientSample, the service principal is passed in on the
 129      * command line, however, in a real world example, this would be
 130      * unacceptable from a user interface standpoint since the user
 131      * shouldn't need to know the server's service principal.
 132      *
 133      * In traditional Kerberos setups, the service principal would be
 134      * constructed from the type of the service (eg: "imap"), the DNS
 135      * hostname of the server (eg: "mailserver.domain.com") and the
 136      * client's local realm (eg: "DOMAIN.COM") to form a full
 137      * principal string (eg: "imap/mailserver.domain.com@DOMAIN.COM").
 138      *
 139      * Now that many sites do not have DNS, this setup is becoming
 140      * less common.  However you decide to generate the service
 141      * principal, you need to adhere to the following constraint: The
 142      * service principal must be constructed by the client, typed in
 143      * by the user or administrator, or transmitted to the client in a
 144      * secure manner from a trusted third party -- such as through an
 145      * encrypted connection to a directory server.  You should not
 146      * have the server send the client the service principal name as
 147      * part of the authentication negotiation.
 148      *
 149      * The reason you can't let the server tell the client which
 150      * principal to use is that many machines at a site will have
 151      * their own service principal and keytab which identifies the
 152      * machine -- in a Windows Active Directory environment all
 153      * machines have a service principal and keytab.  Some of these
 154      * machines (such as a financial services server) will be more
 155      * trustworthy than others (such as a random machine on a
 156      * coworker's desk).  If the owner of one of these untrustworthy
 157      * machines can trick the client into using the untrustworthy
 158      * machine's principal instead of the financial services server's
 159      * principal, then he can trick the client into authenticating and
 160      * connecting to the untrustworthy machine.  The untrustworthy
 161      * machine can then harvest any confidential information the
 162      * client sends to it, such as credit card information or social
 163      * security numbers.
 164      *
 165      * If your protocol already involves sending the service principal
 166      * as part of your authentication negotiation, your client should
 167      * cache the name it gets after the first successful
 168      * authentication so that the problem above can only happen on the
 169      * first connection attempt -- similar to what ssh does with host
 170      * keys.
 171      */
 172
 173     if (!err) {
 174       nameBuffer.length = asprintf(&name, "%s@%s", inServiceName, inHost);
 175       nameBuffer.value = name;
 176
 177       majorStatus = gss_import_name (&minorStatus, &nameBuffer, (gss_OID) GSS_C_NT_HOSTBASED_SERVICE, &serviceName);
 178       if (majorStatus != GSS_S_COMPLETE) {
 179         gsscon_print_gss_errors ("gss_import_name(inServiceName)", majorStatus, minorStatus);
 180         err = minorStatus ? minorStatus : majorStatus;
 181       }
 182     }
 183
 184     /*
 185      * The main authentication loop:
 186      *
 187      * GSS is a multimechanism API.  Because the number of packet
 188      * exchanges required to authenticate can vary between mechanisms,
 189      * we need to loop calling gss_init_sec_context, passing the
 190      * "input tokens" received from the server and send the resulting
 191      * "output tokens" back until we get GSS_S_COMPLETE or an error.
 192      */
 193
 194     majorStatus = GSS_S_CONTINUE_NEEDED;
 195
 196     gss_OID_desc EAP_OID = { 9, "\x2B\x06\x01\x05\x05\x0F\x01\x01\x11" };
 197
 198     while (!err && (majorStatus != GSS_S_COMPLETE)) {
 199         gss_buffer_desc outputToken = { 0, NULL }; /* buffer to send to the server */
 200         OM_uint32 requestedFlags = (GSS_C_MUTUAL_FLAG | GSS_C_REPLAY_FLAG | GSS_C_SEQUENCE_FLAG |
 201                                     GSS_C_CONF_FLAG | GSS_C_INTEG_FLAG);
 202
 203         majorStatus = gss_init_sec_context (&minorStatus,
 204                                             clientCredentials,
 205                                             &gssContext,
 206                                             serviceName,
 207                                             &EAP_OID /* mech_type */,
 208                                             requestedFlags,
 209                                             GSS_C_INDEFINITE,
 210                                             GSS_C_NO_CHANNEL_BINDINGS,
 211                                             inputTokenPtr,
 212                                             NULL /* actual_mech_type */,
 213                                             &outputToken,
 214                                             &actualFlags,
 215                                             NULL /* time_rec */);
 216
 217         /* Send the output token to the server (even on error) */
 218         if ((outputToken.length > 0) && (outputToken.value != NULL)) {
 219             err = gsscon_write_token (*outFD, outputToken.value, outputToken.length);
 220
 221             /* free the output token */
 222             gss_release_buffer (&minorStatusToo, &outputToken);
 223         }
 224
 225         if (!err) {
 226             if (majorStatus == GSS_S_CONTINUE_NEEDED) {
 227                 /* Protocol requires another packet exchange */
 228
 229                 /* Clean up old input buffer */
 230                 if (inputTokenBuffer) {
 231                     free (inputTokenBuffer);
 232                     inputTokenBuffer = NULL;  /* don't double-free */
 233                 }
 234
 235                 /* Read another input token from the server */
 236                 err = gsscon_read_token (*outFD, &inputTokenBuffer, &inputTokenBufferLength);
 237
 238                 if (!err) {
 239                     /* Set up input buffers for the next run through the loop */
 240                     inputToken.value = inputTokenBuffer;
 241                     inputToken.length = inputTokenBufferLength;
 242                     inputTokenPtr = &inputToken;
 243                 }
 244             } else if (majorStatus != GSS_S_COMPLETE) {
 245                 gsscon_print_gss_errors ("gss_init_sec_context", majorStatus, minorStatus);
 246                 err = minorStatus ? minorStatus : majorStatus;
 247             }
 248         }
 249     }
 250
 251     if (!err) {
 252         *outGSSContext = gssContext;
 253         gssContext = NULL;
 254     } else {
 255         gsscon_print_error (err, "AuthenticateToServer failed");
 256     }
 257
 258     if (inputTokenBuffer) { free (inputTokenBuffer); }
 259     if (serviceName     ) { gss_release_name (&minorStatus, &serviceName); }
 260     if (clientName      ) { gss_release_name (&minorStatus, &clientName); }
 261
 262     if (clientCredentials != GSS_C_NO_CREDENTIAL) {
 263         gss_release_cred (&minorStatus, &clientCredentials); }
 264     if (gssContext != GSS_C_NO_CONTEXT) {
 265         gss_delete_sec_context (&minorStatus, &gssContext, GSS_C_NO_BUFFER); }
 266
 267     return err;
 268 }
 269