mech_eap/util_shib.h

   1 /*
   2  * Copyright (c) 2011, 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 /*
  34  * Local attribute provider.
  35  */
  36
  37 #ifndef _UTIL_SHIB_H_
  38 #define _UTIL_SHIB_H_ 1
  39
  40 #ifdef __cplusplus
  41
  42 #include <vector>
  43
  44 namespace shibsp {
  45     class Attribute;
  46 };
  47
  48 namespace shibresolver {
  49     class ShibbolethResolver;
  50 };
  51
  52 struct gss_eap_shib_attr_provider : gss_eap_attr_provider {
  53 public:
  54     gss_eap_shib_attr_provider(void);
  55     ~gss_eap_shib_attr_provider(void);
  56
  57     bool initWithExistingContext(const gss_eap_attr_ctx *source,
  58                                  const gss_eap_attr_provider *ctx);
  59     bool initWithGssContext(const gss_eap_attr_ctx *source,
  60                             const gss_cred_id_t cred,
  61                             const gss_ctx_id_t ctx);
  62
  63     bool setAttribute(int complete,
  64                       const gss_buffer_t attr,
  65                       const gss_buffer_t value);
  66     bool deleteAttribute(const gss_buffer_t value);
  67     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  68     bool getAttribute(const gss_buffer_t attr,
  69                       int *authenticated,
  70                       int *complete,
  71                       gss_buffer_t value,
  72                       gss_buffer_t display_value,
  73                       int *more) const;
  74     gss_any_t mapToAny(int authenticated,
  75                        gss_buffer_t type_id) const;
  76     void releaseAnyNameMapping(gss_buffer_t type_id,
  77                                gss_any_t input) const;
  78
  79     const char *prefix(void) const;
  80     const char *name(void) const;
  81     bool initWithJsonObject(const gss_eap_attr_ctx *manager,
  82                             JSONObject &obj);
  83     JSONObject jsonRepresentation(void) const;
  84
  85     static bool init(void);
  86     static void finalize(void);
  87
  88     OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
  89
  90     static gss_eap_attr_provider *createAttrContext(void);
  91
  92     std::vector<shibsp::Attribute *> getAttributes(void) const {
  93         return m_attributes;
  94     }
  95
  96 private:
  97     static shibsp::Attribute *
  98         duplicateAttribute(const shibsp::Attribute *src);
  99     static std::vector <shibsp::Attribute *>
 100         duplicateAttributes(const std::vector <shibsp::Attribute *>src);
 101
 102     ssize_t getAttributeIndex(const gss_buffer_t attr) const;
 103     const shibsp::Attribute *getAttribute(const gss_buffer_t attr) const;
 104
 105     bool authenticated(void) const { return m_authenticated; }
 106
 107     bool m_initialized;
 108     bool m_authenticated;
 109     std::vector<shibsp::Attribute *> m_attributes;
 110 };
 111
 112 extern "C" {
 113 #endif
 114
 115 OM_uint32 gssEapLocalAttrProviderInit(OM_uint32 *minor);
 116 OM_uint32 gssEapLocalAttrProviderFinalize(OM_uint32 *minor);
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif /* _UTIL_SHIB_H_ */