SSPCPP-654 - Move fork wait timeout from init script to sysconfig

[shibboleth/cpp-sp.git] / shibsp / SessionCache.h

diff --git a/shibsp/SessionCache.h b/shibsp/SessionCache.h
index 932f9de..7b7a6d6 100644 (file)
--- a/shibsp/SessionCache.h
+++ b/shibsp/SessionCache.h
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2010 Internet2
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
@@ -30,6 +34,7 @@
 #include <string>
 #include <vector>
 #include <ctime>
+#include <xercesc/util/XercesDefs.hpp>
 #include <xmltooling/Lockable.h>
 
 namespace xmltooling {
@@ -44,6 +49,9 @@ namespace opensaml {
     namespace saml2 {
         class SAML_API NameID;
     };
+    namespace saml2md {
+        class SAML_API EntityDescriptor;
+    };
 };
 #endif
 
@@ -224,6 +232,7 @@ namespace shibsp {
 
 #ifndef SHIBSP_LITE
         /**
+         * @deprecated
          * Inserts a new session into the cache and binds the session to the outgoing
          * client response.
          *
@@ -260,6 +269,46 @@ namespace shibsp {
             )=0;
 
         /**
+         * Inserts a new session into the cache and binds the session to the outgoing
+         * client response.
+         *
+         * <p>The newly created session ID is placed into the first parameter.
+         *
+         * <p>The SSO tokens and Attributes remain owned by the caller and are copied by the cache.
+         *
+         * @param sessionID         reference to string to capture newly inserted session ID
+         * @param application       reference to Application that owns the Session
+         * @param httpRequest       request that initiated session
+         * @param httpResponse      current response to client
+         * @param expires           expiration time of session
+         * @param issuer            issuing metadata of assertion issuer, if known
+         * @param protocol          protocol family used to initiate the session
+         * @param nameid            principal identifier, normalized to SAML 2, if any
+         * @param authn_instant     UTC timestamp of authentication at IdP, if known
+         * @param session_index     index of session between principal and IdP, if any
+         * @param authncontext_class    method/category of authentication event, if known
+         * @param authncontext_decl specifics of authentication event, if known
+         * @param tokens            assertions to cache with session, if any
+         * @param attributes        optional array of resolved Attributes to cache with session
+         */
+        virtual void insert(
+            std::string& sessionID,
+            const Application& application,
+            const xmltooling::HTTPRequest& httpRequest,
+            xmltooling::HTTPResponse& httpResponse,
+            time_t expires,
+            const opensaml::saml2md::EntityDescriptor* issuer=nullptr,
+            const XMLCh* protocol=nullptr,
+            const opensaml::saml2::NameID* nameid=nullptr,
+            const XMLCh* authn_instant=nullptr,
+            const XMLCh* session_index=nullptr,
+            const XMLCh* authncontext_class=nullptr,
+            const XMLCh* authncontext_decl=nullptr,
+            const std::vector<const opensaml::Assertion*>* tokens=nullptr,
+            const std::vector<Attribute*>* attributes=nullptr
+            );
+
+        /**
          * Determines whether the Session bound to a client request matches a set of input criteria.
          *
          * @param application   reference to Application that owns the Session