shibsp/GSSRequest.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file shibsp/GSSRequest.h
  23  *
  24  * Interface to a GSS-authenticated request.
  25  */
  26
  27 #if !defined(__shibsp_gssreq_h__) && defined(SHIBSP_HAVE_GSSAPI)
  28 #define __shibsp_gssreq_h__
  29
  30 #include <shibsp/base.h>
  31 #include <xmltooling/io/GenericRequest.h>
  32
  33 #ifdef SHIBSP_HAVE_GSSGNU
  34 # include <gss.h>
  35 #elif defined SHIBSP_HAVE_GSSMIT
  36 # include <gssapi/gssapi.h>
  37 # include <gssapi/gssapi_generic.h>
  38 #else
  39 # include <gssapi.h>
  40 #endif
  41
  42 namespace shibsp {
  43
  44     /**
  45      * Interface to a GSS-authenticated request.
  46      */
  47     class SHIBSP_API GSSRequest : public virtual xmltooling::GenericRequest
  48     {
  49     protected:
  50         GSSRequest();
  51     public:
  52         virtual ~GSSRequest();
  53
  54         /**
  55          * Returns the GSS-API context established for this request, or
  56          * GSS_C_NO_CONTEXT if none is available.
  57          *
  58          * @return  a GSS-API context handle, or GSS_C_NO_CONTEXT
  59          */
  60         virtual gss_ctx_id_t getGSSContext() const=0;
  61
  62         /**
  63          * Returns the GSS-API initiator name established for this request, or
  64          * GSS_C_NO_NAME if none is available.
  65          *
  66          * @return  a GSS-API name, or GSS_C_NO_NAME
  67          */
  68         virtual gss_name_t getGSSName() const;
  69     };
  70 };
  71
  72 #endif /* __shibsp_gssreq_h__ */