auth_gss.h

Go to the documentation of this file.

/*
  auth_gss.h
  
  Copyright (c) 2000 The Regents of the University of Michigan.
  All rights reserved.
  
  Copyright (c) 2000 Dug Song <dugsong@UMICH.EDU>.
  All rights reserved, all wrongs reversed.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:
 
  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
  3. Neither the name of the University nor the names of its
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
/* NFSv4.1 client for Windows
 * Copyright © 2012 The Regents of the University of Michigan
 *
 * Olga Kornievskaia <aglo@umich.edu>
 * Casey Bodley <cbodley@umich.edu>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 *
 * This library 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 */
 
#ifndef _TIRPC_AUTH_GSS_H
#define _TIRPC_AUTH_GSS_H
 
#include <rpc/clnt.h>
#define SECURITY_WIN32
#include <sspi.h>
 
/* RPCSEC_GSS control procedures. */
typedef enum {
    RPCSEC_GSS_DATA = 0,
    RPCSEC_GSS_INIT = 1,
    RPCSEC_GSS_CONTINUE_INIT = 2,
    RPCSEC_GSS_DESTROY = 3
} rpc_gss_proc_t;
 
/* RPCSEC_GSS services. */
typedef enum {
    RPCSEC_GSS_SVC_NONE = 1,
    RPCSEC_GSS_SVC_INTEGRITY = 2,
    RPCSEC_GSS_SVC_PRIVACY = 3
} rpc_gss_svc_t;
 
#define RPCSEC_GSS_VERSION  1
 
/* RPCSEC_GSS security triple. */
struct rpc_gss_sec {
    gss_OID     mech;       /* mechanism */
    gss_qop_t   qop;        /* quality of protection */
    rpc_gss_svc_t   svc;        /* service */
    gss_cred_id_t   cred;       /* cred handle */
    u_int       req_flags;  /* req flags for init_sec_context */
};
 
/* Private data required for kernel implementation */
struct authgss_private_data {
    gss_ctx_id_t    pd_ctx;     /* Session context handle */
    gss_buffer_desc pd_ctx_hndl;    /* Credentials context handle */
    u_int       pd_seq_win; /* Sequence window */
};
 
#define g_OID_equal(o1, o2) \
   (((o1)->length == (o2)->length) && \
    ((o1)->elements != 0) && ((o2)->elements != 0) && \
    (memcmp((o1)->elements, (o2)->elements, (int) (o1)->length) == 0))
 
/* from kerberos source, gssapi_krb5.c */
extern gss_OID_desc krb5oid;
extern gss_OID_desc spkm3oid;
 
/* Credentials. */
struct rpc_gss_cred {
    u_int       gc_v;       /* version */
    rpc_gss_proc_t  gc_proc;    /* control procedure */
    u_int       gc_seq;     /* sequence number */
    rpc_gss_svc_t   gc_svc;     /* service */
    gss_buffer_desc gc_ctx;     /* context handle */
};
 
/* Context creation response. */
struct rpc_gss_init_res {
    gss_buffer_desc     gr_ctx;     /* context handle */
    u_int           gr_major;   /* major status */
    u_int           gr_minor;   /* minor status */
    u_int           gr_win;     /* sequence window */
    gss_buffer_desc     gr_token;   /* token */
};
 
/* Maximum sequence number value. */
#define MAXSEQ      0x80000000
 
#ifdef __REACTOS__
#ifndef __BEGIN_DECLS
#define __BEGIN_DECLS
#define __END_DECLS
#endif
#endif
 
/* Prototypes. */
__BEGIN_DECLS
bool_t  xdr_rpc_gss_cred    __P((XDR *xdrs, struct rpc_gss_cred *p));
bool_t  xdr_rpc_gss_init_args   __P((XDR *xdrs, gss_buffer_desc *p));
bool_t  xdr_rpc_gss_init_res    __P((XDR *xdrs, struct rpc_gss_init_res *p));
bool_t  xdr_rpc_gss_data    __P((XDR *xdrs, xdrproc_t xdr_func,
                     caddr_t xdr_ptr, gss_ctx_id_t ctx,
                     gss_qop_t qop, rpc_gss_svc_t svc,
                     u_int seq));
 
AUTH   *authgss_create      __P((CLIENT *, gss_name_t,
                     struct rpc_gss_sec *));
AUTH   *authgss_create_default  __P((CLIENT *, char *, struct rpc_gss_sec *));
bool_t authgss_service      __P((AUTH *auth, int svc));
bool_t authgss_get_private_data __P((AUTH *auth,
                         struct authgss_private_data *));
 
void    log_debug       __P((const char *fmt, ...));
void    log_status      __P((char *m, OM_uint32 major,
                     OM_uint32 minor));
void    log_hexdump     __P((const u_char *buf, int len, int offset));
 
__END_DECLS
 
#endif /* !_TIRPC_AUTH_GSS_H */