krb5.h

Go to the documentation of this file.

#pragma once
/*
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: 048b360f013c215e8bb4a240e171a5a28cb00ff8 $
 * @file krb5.h
 * @brief types and function signatures for rlm_krb5.
 *
 * @copyright 2013 The FreeRADIUS server project
 * @copyright 2013 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSIDH(krb5_h, "$Id: 048b360f013c215e8bb4a240e171a5a28cb00ff8 $")
 
/* krb5 includes */
USES_APPLE_DEPRECATED_API
#include <krb5.h>
 
#ifdef KRB5_IS_THREAD_SAFE
#  include <freeradius-devel/util/slab.h>
#endif
 
typedef struct {
        krb5_context    context;
        krb5_keytab     keytab;
 
#ifdef HEIMDAL_KRB5
        krb5_ccache     ccache;
        krb5_verify_opt options;
#endif
} rlm_krb5_handle_t;
 
/** Instance configuration for rlm_krb5
 *
 * Holds the configuration and preparsed data for a instance of rlm_krb5.
 */
typedef struct {
#ifdef KRB5_IS_THREAD_SAFE
        fr_slab_config_t        reuse;
#else
        rlm_krb5_handle_t       *conn;
#endif
 
        char const              *name;          //!< This module's instance name.
        char const              *keytabname;    //!< The keytab to resolve the service in.
        char const              *service_princ; //!< The service name provided by the
                                                //!< config parser.
 
        char                    *hostname;      //!< The hostname component of
                                                //!< service_princ, or NULL.
        char                    *service;       //!< The service component of service_princ, or NULL.
 
        krb5_context            context;        //!< The kerberos context (cloned once per request).
 
#ifndef HEIMDAL_KRB5
        krb5_get_init_creds_opt         *gic_options;   //!< Options to pass to the get_initial_credentials
                                                        //!< function.
        krb5_verify_init_creds_opt      *vic_options;   //!< Options to pass to the validate_initial_creds
                                                        //!< function.
 
        krb5_principal server;                  //!< A structure representing the parsed
                                                //!< service_princ.
#endif
} rlm_krb5_t;
 
#ifdef KRB5_IS_THREAD_SAFE
FR_SLAB_TYPES(krb5, rlm_krb5_handle_t)
FR_SLAB_FUNCS(krb5, rlm_krb5_handle_t)
 
typedef struct {
        rlm_krb5_t const        *inst;
        krb5_slab_list_t        *slab;
} rlm_krb5_thread_t;
#endif
 
/*
 *      MIT Kerberos uses comm_err, so the macro just expands to a call
 *      to error_message.
 */
#ifndef HAVE_KRB5_GET_ERROR_MESSAGE
#  ifdef ET_COMM_ERR
#    include <et/com_err.h>
#  else
#    include <com_err.h>
#  endif
#  define rlm_krb5_error(_x, _y, _z) error_message(_z)
#  define KRB5_UNUSED UNUSED
#else
char const *rlm_krb5_error(rlm_krb5_t const *inst, krb5_context context, krb5_error_code code);
# define KRB5_UNUSED
#endif
 
int krb5_handle_init(rlm_krb5_handle_t *conn, void *uctx);
void *krb5_mod_conn_create(TALLOC_CTX *ctx, void *instance, fr_time_delta_t timeout);