Use shibboleth-sp as package name for compatibility.

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

diff --git a/shibsp/AccessControl.h b/shibsp/AccessControl.h
index 0f26f99..be1472b 100644 (file)
--- a/shibsp/AccessControl.h
+++ b/shibsp/AccessControl.h
@@ -1,22 +1,26 @@
-/*
- *  Copyright 2001-2006 Internet2
- * 
- * 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
+/**
+ * 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.
+ *
+ * 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.
  */
 
 /**
  * @file shibsp/AccessControl.h
- * 
+ *
  * Interface to an access control plugin
  */
 
@@ -33,7 +37,7 @@ namespace shibsp {
 
      /**
      * Interface to an access control plugin
-     * 
+     *
      * Access control plugins return authorization decisions based on the intersection
      * of the resource request and the active session. They can be implemented through
      * cross-platform or platform-specific mechanisms.
@@ -42,18 +46,27 @@ namespace shibsp {
     {
         MAKE_NONCOPYABLE(AccessControl);
     protected:
-        AccessControl() {}
+        AccessControl();
     public:
-        virtual ~AccessControl() {}
+        virtual ~AccessControl();
+
+        /**
+         * Possible results from an access control decision.
+         */
+        enum aclresult_t {
+            shib_acl_true,
+            shib_acl_false,
+            shib_acl_indeterminate
+        };
 
         /**
          * Perform an authorization check.
-         * 
+         *
          * @param request   SP request information
          * @param session   active user session, if any
          * @return true iff access should be granted
          */
-        virtual bool authorized(const SPRequest& request, const Session* session) const=0;
+        virtual aclresult_t authorized(const SPRequest& request, const Session* session) const=0;
     };
 
     /**
@@ -61,11 +74,14 @@ namespace shibsp {
      */
     void SHIBSP_API registerAccessControls();
 
+    /** Chains together multiple plugins. */
+    #define CHAINING_ACCESS_CONTROL "Chaining"
+
     /** AccessControl based on rudimentary XML syntax. */
-    #define XML_ACCESS_CONTROL  "edu.internet2.middleware.shibboleth.sp.provider.XMLAccessControl"
+    #define XML_ACCESS_CONTROL      "XML"
 
     /** Reserved for Apache-style .htaccess support. */
-    #define HT_ACCESS_CONTROL   "edu.internet2.middleware.shibboleth.sp.apache.provider.htAccessControl"
+    #define HT_ACCESS_CONTROL       "htaccess"
 };
 
 #endif /* __shibsp_acl_h__ */