-## Welcome to the Opendaylight AAA Project!
+## Opendaylight AAA
-This project is aimed at providing a flexible, pluggable framework with out-of-the-box capabilities for:
+This project is aimed at providing a flexible, pluggable framework with out-of-the-box capabilities for Authentication, Authorization and Accounting (AAA).
-* *Authentication*: Means to authenticate the identity of both human and machine users (direct or federated).
-* *Authorization*: Means to authorize human or machine user access to resources including RPCs, notification subscriptions, and subsets of the datatree.
-* *Accounting*: Means to record and access the records of human or machine user access to resources including RPCs, notifications, and subsets of the datatree
+## Caveats
+The following caveats are applicable to the current AAA implementation:
+ - The database (H2) used by ODL AAA Authentication store is not-cluster enabled. When deployed in a clustered environment each node contains unique local credentials.
+ - AAA provides two local IdP Realm implementations; TokenAuthRealm and MdsalRealm. Although the use of both Realms at the same time is possible through Shiro's multi-realm approach, it is considered bad practice to provide two local identity stores. Thus, users should specify one or the other for $securityManager.realms entry in the aaa-app-config configuration.
+ - The MdsalRealm is not initialized with any Users, Roles, Domains, or Grants. The ability to add OOB Identity Information is considered separate work, and is targeted for the Oxygen release.
## Quick Start
*Prerequisite:* The followings are required for building AAA:
-- Maven3
-- Java 7
+- Maven 3.3.9+
+- JDK8
+- Python 2.7+ (optional) for running wrapper scripts
Get the code:
+Using HTTPS:
git clone https://git.opendaylight.org/gerrit/aaa
+USING SSH:
+ git clone ssh://{USERNAME}@git.opendaylight.org:29418/aaa
+
Build it:
cd aaa && mvn clean install
### Installing
-AAA installs into an existing Opendaylight controller Karaf installation. If you don't have an Opendaylight installation, please refer to this [page](https://wiki.opendaylight.org/view/OpenDaylight_Controller:Installation).
-
-Start the controller Karaf container:
-
- bin/karaf
-
-Install AAA repository from the Karaf shell:
-
- repo-add mvn:org.opendaylight.aaa/features-aaa/0.1.0-SNAPSHOT/xml/features
-
-Install all AAA features:
-
- feature:install odl-aaa-all
-
-### Protecting your REST/RestConf resources
+AAA is automatically installed upon installation of odl-restconf-noauth and enabled through aaa-shiro-act.
-Add the AAA `TokeAuthFilter` filter to your REST resource (RESTconf example):
+If you are using AAA from a non-RESTCONF context, you can install the necessary javax.servlet.Filter(s) through the following command:
- <servlet>
- <servlet-name>JAXRSRestconf</servlet-name>
- <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
- <init-param>
- <param-name>javax.ws.rs.Application</param-name>
- <param-value>org.opendaylight.controller.sal.rest.impl.RestconfApplication</param-value>
- </init-param>
-
- <!-- Token Auth Filter -->
- <init-param>
- <param-name>com.sun.jersey.spi.container.ContainerRequestFilters</param-name>
- <param-value>
- org.opendaylight.aaa.sts.TokenAuthFilter
- </param-value>
- </init-param>
-
- <load-on-startup>1</load-on-startup>
- </servlet>
-
-Rebuild and re-install your REST resource.
+ feature:install odl-aaa-shiro
### Running
-Once the installation finishes, one can authenticates with the Opendaylight controller by presenting a username/password and a domain name (scope) to be logged into:
+Once the installation finishes, one can authenticate with the OpenDaylight controller by presenting a username/password and a domain name (scope):
- curl -s -d 'grant_type=password&username=admin&password=
odl&scope=pepsi' http://<controller>:<port>/oauth2/token
+ curl -s -d 'grant_type=password&username=admin&password=
admin&scope=sdn' http://<controller>:<port>/oauth2/token
Upon successful authentication, the controller returns an access token with a configurable expiration in seconds, something similar to the followings:
curl -s -H 'Authorization: Bearer d772d85e-34c7-3099-bea5-cfafd3c747cb' http://<controller>:<port>/restconf/operational/opendaylight-inventory:nodes
+### Defaults
+
+Although it is poor security practice, AAA's TokenAuthRealm creates some defaults out of the box. In order to avoid default credentials, please see the aaa-cli-jar module, which allows installers to pre-install identity information. Due to the fact that OpenDaylight does not have a proper installer project, default credentials become a chicken/egg problem. The choice to utilize defaults was initially decided to help bootstrap interaction with ODL's restful web services. AAA's TokenAuthRealm creates:
+* the "sdn" domain
+* the "admin" and "user" roles
+* the "admin" user with "admin" password
+* 2 grants
+ * admin user is granted admin role priveledges on sdn domain
+ * admin user is granted user role priveledges on sdn domain
+
+TokenAuthRealm's H2 file-based database, which stores the identity information, is secured with default credentials "foo"/"bar". Default credentials on the local file-based database is a smaller concern, since without running an H2 Server instance on the local machine (ODL doesn't by default), the database is only accessible locally (i.e., user in front of keyboard). However, these credentials can be adjusted too by setting "dbUsername" and "dbPassword" within etc/org.opendaylight.aaa.h2.cfg.
+
## Framework Overview
### Authentication
#### Direct
-In this use-case, a user presents some credentials (e.g., username/password) directly to the Opendaylight (ODL) controller token endpoint `/oauth2/token` and receives an access token, which then can be used to access protected resources on the controller, similar to the example we saw in the Quickstart section:
+In this use-case, a user presents some credentials (e.g., username/password) directly to the Opendaylight (ODL) controller token endpoint `/oauth2/token` and receives an access token, which then can be used to access protected resources on the controller, similar to the example we saw in the Quickstart section.
-
+#### Federated
-Here, the Opendaylight controller takes on 3 respective roles:
+In the federated use-case, the responsibility of authentication is delegated to a third-party IdP (perhaps, an enterprise-level IdP).
-- *Identity Provider*: Authenticates a user given some credentials.
-- *Authorization Server*: Determines what roles/permissions an authenticated user has.
-- *Resource Provider*: Provides access to a given resource based on the user's roles/permissions.
+For more information, consult ODLJndiLdapRealm and ODLJndiLdapRealmAuthnOnly documentation.
-The built-in IdP for Opendaylight can be swapped out by a different implementation of the `org.opendaylight.aaa.api.CredentialAuth` API.
+### Authorization & Access Control
-#### Federated
+ODL supports two authorization engines at present, both of which are roughly similar in behavior. Namely, the two authorization engines are the MDSALDynamicAuthorizationFilter(1) and the RolesAuthorizationFilter(2). For several reasons explained further in this documentation, we STRONGLY encourage you to use the MDSALDyanmicAuthorizationFilter(1) approach over the RolesAuthorizationFilter(2).
-In the federated use-case, the responsibility of authentication is delegated to a third-party IdP (perhaps, an enterprise-level IdP):
+1) MDSALDyanmicAuthorizationFilter
-
+The MDSALDynamicAuthorizationFilter is a mechanism used to restrict access to partcular URL endpoint patterns. Users may define a list of policies that are insertion-ordered. Order matters for the list of policies, since the first matching policy is applied. This choice was made to emulate behavior of the Apache Shiro RolesAuthorizationFilter.
-In the above use-case, the user authenticates with a third-party IdP (username/password is shown as an example, but it could be anything that the IdP supports, such as MFA, OTP, etc...). Upon successful authentication, the IdP returns back a claim about the identity of that user. The claim is then submitted to the Opendaylight token endpoint in exchange for an access token that can be used to access protected resources on the controller. The IdP claim must be mapped into a corresponding ODL claim (user/domain/role) before an access token can be granted.
+A policy is a key/value pair, where the key is a resource (i.e., a "url pattern") and the value is a list of permissions for the resource. The following describes the various elements of a policy:
-The Opendaylight controller comes with SSSD-based claim support, but other types of claim support can be also added with their implementation of the `org.opendaylight.aaa.api.ClaimAuth` API.
+resource: The resource is a string url pattern as outlined by Apache Shiro. For more information, see http://shiro.apache.org/web.html.
+description: An optional description of the URL endpoint and why it is being secured.
+permissions list: A list of permissions for a particular policy. If more than one permission exists in the permissions list, the permissions are evaluted using logical "OR".
-We can also take federation one step further and delegate token management and optionally part of the authorization responsibility to the third-party IdP:
+A permission describes the prerequisites to perform HTTP operations on a particular endpoint. The following describes the various elements of a permission:
-
+role: The role required to access the target URL endpoint.
+actions list: A leaf-list of HTTP permissions that are allowed for a Subject possessing the required role.
-In this case, we use the IdP token directly as an access token to access protected resources on the controller. The controller maintains only enough information needed for access control. Validation of the token is performed by implementation of the `org.opendaylight.aaa.api.TokenAuth` API and can be daisy-chained as resource filters on the controller, with the last filter being the controller's built-in `org.opendaylight.aaa.sts.DirectTokenAuthFilter` to properly register the authentication context.
+---------
+Example:
-### Authorization & Access Control
+To limit access to the modules endpoint, issue the following:
+
+HTTP Operation: put
+URL: /restconf/config/aaa:http-authorization/policies
+Headers:
+ Content-Tye: application/json
+ Accept: application/json
+
+Body:
+
+{
+ "aaa:policies": {
+ "aaa:policies": [
+ {
+ "aaa:resource": "/restconf/modules/**",
+ "aaa:permissions": [
+ {
+ "aaa:role": "admin",
+ "aaa:actions": [
+ "get","post","put","patch","delete"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+}
+--------
+The above example locks down access to the modules endpoint (and any URLS available past modules) to the "admin" role. Thus, an attempt from the OOB admin user will succeed with 2XX HTTP status code, while an attempt from the OOB "user" user will fail with HTTP status code 401, as the "user" user is not granted the "admin" role.
+
+NOTE: "aaa:resource" value starts with "/restconf". Unlike the RolesAuthorizationFilter ("roles" in shiro.ini) which is relative to the ServletContext, The MDSALDyanmicAuthorizationFilter is relative to the Servlet Root (i.e., "/"). This is superior, as it is more specific and does not allow for ambiguity.
+
+2) aaa-app-config clustered application configuration "urls" section Authorization roles filter (i.e., "RolesAuthorizationFilter"). [DEPRECATED]
+
+Authorization is implemented via the aaa-shiro modules. RolesAuthorizationFilter (roles filter) is limited purely to RESTCONF (HTTP) and does not focus on MD-SAL.
+
+More information on how to configure authorization can be found on the Apache Shiro website:
+
+ http://shiro.apache.org/web.html
+
+NOTE: Use of shiro.ini urls section to define roles requirements is discouraged! This is due to the fact that shiro.ini changes are only recognized on servlet container startup. Changes to shiro.ini are only honored upon restart.
+
+NOTE: Use of shiro.ini urls section to define roles requirements is discouraged! This is due to the fact that url patterns are matched relative to the servlet context. This leaves room for ambiguity, since many endpoints may match (i.e., "/restconf/modules" and "/auth/modules" would both match a "/modules/**" rule).
+
+### Accounting
+
+Accounting is handled through the standard slf4j logging mechanisms used by the rest of OpenDaylight. Thus, one can control logging verbosity through manipulating the log levels for individual packages and classes directly through the karaf shell, JMX, or etc/org.ops4j.pax.logging.cfg. In normal operations, the default levels exposed do not provide much information about AAA services; this is due to the fact that logging can severely degrade performance.
+
+Two noteworthy logging activities are:
+1) Enable debugging logging
+2) Enable successful/unsuccessful authentication attempts logging
-Upon successful authentication, an authentication context is created and is available for access via the OSGi service `org.opendaylight.aaa.api.AuthenticationService`. The authentication context consists of the following information:
+#### Enable Debugging Logging
-* UserId/Name
-* DomainId/Name
-* Roles
+For debugging purposes (i.e., to enable maximum verbosity), issue the following command:
-Based on the current authentication context, it is the responsibility of the OSGi applications within the controller to provide the appropriate access control, via bespoke logic or the MD-SAL security framework.
+karaf> log:set TRACE org.opendaylight.aaa
-*More on MD-SAL authorization later...*
+#### Enable Successful/Unsuccessful Authentication Attempts Logging
+By default, successful/unsuccessful authentication attempts are NOT logged. This is due to the fact that logging can severely decrease REST performance. To enable logging of successful/unsuccessful REST attempts, issue the following command:
-### Accounting
+karaf> log:set DEBUG org.opendaylight.aaa.shiro.filters.AuthenticationListener
-*More on Accounting later...*
\ No newline at end of file
+It is possible to add custom AuthenticationListener(s) to the Shiro based configuration, allowing different ways to listen for successful/unsuccessful authentication attempts. Custom AuthenticationListener(s) must implement the org.apache.shiro.authc.AuthenticationListener interface.
Code Review / aaa.git / blobdiff