util_shib.h

   1 /*
   2  * Copyright (c) 2010, 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 "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #ifndef _UTIL_SHIB_H_
  34 #define _UTIL_SHIB_H_ 1
  35
  36 #ifdef __cplusplus
  37
  38 #include <vector>
  39
  40 namespace shibsp {
  41     class Attribute;
  42 };
  43
  44 namespace shibresolver {
  45     class ShibbolethResolver;
  46 };
  47
  48 struct gss_eap_shib_attr_provider : gss_eap_attr_provider {
  49 public:
  50     gss_eap_shib_attr_provider(void);
  51     ~gss_eap_shib_attr_provider(void);
  52
  53     bool initFromExistingContext(const gss_eap_attr_ctx *source,
  54                                  const gss_eap_attr_provider *ctx);
  55     bool initFromGssContext(const gss_eap_attr_ctx *source,
  56                             const gss_cred_id_t cred,
  57                             const gss_ctx_id_t ctx);
  58
  59     void setAttribute(int complete,
  60                       const gss_buffer_t attr,
  61                       const gss_buffer_t value);
  62     void deleteAttribute(const gss_buffer_t value);
  63     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  64     bool getAttribute(const gss_buffer_t attr,
  65                       int *authenticated,
  66                       int *complete,
  67                       gss_buffer_t value,
  68                       gss_buffer_t display_value,
  69                       int *more) const;
  70     gss_any_t mapToAny(int authenticated,
  71                        gss_buffer_t type_id) const;
  72     void releaseAnyNameMapping(gss_buffer_t type_id,
  73                                gss_any_t input) const;
  74
  75     void exportToBuffer(gss_buffer_t buffer) const;
  76     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
  77                         const gss_buffer_t buffer);
  78
  79
  80     static bool init();
  81     static void finalize();
  82
  83     static gss_eap_attr_provider *createAttrContext(void);
  84
  85 private:
  86     static shibsp::Attribute *
  87         duplicateAttribute(const shibsp::Attribute *src);
  88     static std::vector <shibsp::Attribute *>
  89         duplicateAttributes(const std::vector <shibsp::Attribute *>src);
  90
  91     int getAttributeIndex(const gss_buffer_t attr) const;
  92     const shibsp::Attribute *getAttribute(const gss_buffer_t attr) const;
  93
  94     std::vector<shibsp::Attribute *> getAttributes(void) const {
  95         return m_attributes;
  96     }
  97
  98     bool authenticated() const { return m_authenticated; }
  99
 100     friend bool
 101     addRadiusAttribute(const gss_eap_attr_provider *source,
 102                        const gss_buffer_t attribute,
 103                        void *data);
 104
 105     std::vector<shibsp::Attribute *> m_attributes;
 106     int m_authenticated;
 107 };
 108
 109
 110 extern "C" {
 111 #endif
 112
 113 OM_uint32 gssEapLocalAttrProviderInit(OM_uint32 *minor);
 114 OM_uint32 gssEapLocalAttrProviderFinalize(OM_uint32 *minor);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* _UTIL_SHIB_H_ */