Comments
[mech_eap.git] / util_attr.h
index 90d56c8..8c4360e 100644 (file)
 #ifndef _UTIL_ATTR_H_
 #define _UTIL_ATTR_H_ 1
 
-#define ATTR_TYPE_RADIUS            0U
-#define ATTR_TYPE_SAML_ASSERTION    1U
-#define ATTR_TYPE_SAML              2U
-#define ATTR_TYPE_LOCAL             3U
-#define ATTR_TYPE_MIN               ATTR_TYPE_RADIUS
-#define ATTR_TYPE_MAX               (ATTR_TYPE_LOCAL + 1U)
-
 #ifdef __cplusplus
 #include <string>
 
@@ -51,6 +44,17 @@ typedef bool
                                const gss_buffer_t attribute,
                                void *data);
 
+#define ATTR_TYPE_RADIUS            0U                  /* RADIUS AVPs */
+#define ATTR_TYPE_SAML_ASSERTION    1U                  /* SAML assertion */
+#define ATTR_TYPE_SAML              2U                  /* SAML attributes */
+#define ATTR_TYPE_LOCAL             3U                  /* Local attributes */
+#define ATTR_TYPE_MIN               ATTR_TYPE_RADIUS
+#define ATTR_TYPE_MAX               ATTR_TYPE_LOCAL
+
+/*
+ * Attribute provider: this represents a source of attributes derived
+ * from the security context.
+ */
 struct gss_eap_attr_provider
 {
 public:
@@ -104,6 +108,8 @@ public:
         return initWithManager(manager);
     }
 
+    virtual time_t getExpiryTime(void) const { return 0; }
+
     static bool init() { return true; }
     static void finalize() {}
 
@@ -120,6 +126,10 @@ private:
 
 typedef gss_eap_attr_provider *(*gss_eap_attr_create_provider)(void);
 
+/*
+ * Attribute context: this manages a set of providers for a given
+ * security context.
+ */
 struct gss_eap_attr_ctx
 {
 public:
@@ -191,18 +201,26 @@ public:
     static void
     unregisterProvider(unsigned int type);
 
+    time_t getExpiryTime(void) const;
+
 private:
+    gss_eap_attr_provider *getPrimaryProvider(void) const;
+
     /* make non-copyable */
     gss_eap_attr_ctx(const gss_eap_attr_ctx&);
     gss_eap_attr_ctx& operator=(const gss_eap_attr_ctx&);
 
-    gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX];
+    gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX + 1];
 };
 
+#endif /* __cplusplus */
+
 #include "util_radius.h"
 #include "util_saml.h"
 #include "util_shib.h"
 
+#ifdef __cplusplus
+
 #include <string>
 #include <new>
 
@@ -234,6 +252,12 @@ struct gss_eap_attr_ctx;
 extern "C" {
 #endif
 
+/*
+ * C wrappers for attribute context functions. These match their
+ * GSS naming extension equivalents. The caller is required to
+ * obtain the name mutex.
+ */
+
 struct gss_eap_attr_ctx *
 gssEapCreateAttrContext(gss_cred_id_t acceptorCred,
                         gss_ctx_id_t acceptorCtx);