3 Authentication, Authorization and Accounting (AAA) Services - User guide
4 ========================================================================
9 Authentication, Authorization and Accounting (AAA) is a term for a
10 framework controlling access to resources, enforcing policies to use
11 those resources and auditing their usage. These processes are the
12 fundamental building blocks for effective network management and security.
14 Authentication provides a way of identifying a user, typically by
15 having the user enter a valid user name and valid password before access
16 is granted. The process of authentication is based on each user having a unique
17 set of criteria for gaining access. The AAA framework compares a user's
18 authentication credentials with other user credentials stored in a database.
19 If the credentials match, the user is granted access to the network.
20 If the credentials don't match, authentication fails and access is denied.
22 Authorization is the process of finding out what an authenticated user is
23 allowed to do within the system, which tasks can do, which API can call, etc.
24 The authorization process determines whether the user has the authority
25 to perform such actions.
27 Accounting is the process of logging the activity of an authenticated user,
28 for example, the amount of data a user has sent and/or received during a
29 session, which APIs called, etc.
35 Authentication, Authorization and Accounting.
38 A claim of access to a group of resources on the controller.
41 A group of resources, direct or indirect, physical, logical, or
42 virtual, for the purpose of access control.
45 A person who either owns or has access to a resource or group of
46 resources on the controller.
49 Opaque representation of a set of permissions, which is merely a
50 unique string as admin or guest.
53 Proof of identity such as user name and password, OTP, biometrics, or
57 A service or application that requires access to the controller.
60 A data set of validated assertions regarding a user, e.g. the role,
64 It is the entity associating a user with his role and domain.
70 Transport Layer Security
73 Command Line Interface
75 Security Framework for AAA services
76 -----------------------------------
78 Since Boron release, the OpenDaylight's AAA services are based on the
79 `Apache Shiro <https://shiro.apache.org/>`_ Java Security Framework. The main
80 configuration file for AAA is located at “etc/shiro.ini” relative to the
81 OpenDaylight Karaf home directory.
87 AAA is enabled through installing the odl-aaa-shiro feature. The vast majority
88 of OpenDaylight's northbound APIs (and all RESTCONF APIs) are protected by AAA
89 by default when installing the +odl-restconf+ feature, since the odl-aaa-shiro
90 is automatically installed as part of them. In the cases that APIs are *not*
91 protected by AAA, this will be noted in the per-project release notes.
96 Edit the “etc/opendaylight/datastore/initial/config/aaa-app-config.xml” file and replace the following:
108 Then restart the Karaf process.
113 AAA plugin utilizes the Shiro Realms to support pluggable authentication &
114 authorization schemes. There are two parent types of realms:
116 - AuthenticatingRealm
118 - Provides no Authorization capability.
120 - Users authenticated through this type of realm are treated
125 - AuthorizingRealm is a more sophisticated AuthenticatingRealm,
126 which provides the additional mechanisms to distinguish users
129 - Useful for applications in which roles determine allowed
132 OpenDaylight contains five implementations:
136 - An AuthorizingRealm built to bridge the Shiro-based AAA service
137 with the h2-based AAA implementation.
139 - Exposes a RESTful web service to manipulate IdM policy on a
140 per-node basis. If identical AAA policy is desired across a
141 cluster, the backing data store must be synchronized using an out
144 - A python script located at “etc/idmtool” is included to help
145 manipulate data contained in the TokenAuthRealm.
147 - Enabled out of the box. This is the realm configured by default.
151 - An AuthorizingRealm built to extract identity information from IdM
152 data contained on an LDAP server.
154 - Extracts group information from LDAP, which is translated into
157 - Useful when federating against an existing LDAP server, in which
158 only certain types of users should have certain access privileges.
160 - Disabled out of the box.
162 - ODLJndiLdapRealmAuthNOnly
164 - The same as ODLJndiLdapRealm, except without role extraction.
165 Thus, all LDAP users have equal authentication and authorization
168 - Disabled out of the box.
170 - ODLActiveDirectoryRealm
172 - Wraps the generic ActiveDirectoryRealm provided by Shiro. This allows for
173 enhanced logging as well as isolation of all realms in a single package,
174 which enables easier import by consuming servlets.
178 - This realm authenticates OpenDaylight users against the OpenStack’s
181 - Disabled out of the box.
185 More than one Realm implementation can be specified. Realms are attempted
186 in order until authentication succeeds or all realm sources are exhausted.
187 Edit the **securityManager.realms = $tokenAuthRealm** property in shiro.ini
188 and add all the realms needed separated by commas.
196 The TokenAuthRealm is the default Authorization Realm deployed in OpenDaylight.
197 TokenAuthRealm uses a direct authentication mechanism as shown in the following
200 .. figure:: ./images/aaa/direct-authentication.png
201 :alt: TokenAuthRealm direct authentication mechanism
203 TokenAuthRealm direct authentication mechanism
205 A user presents some credentials (e.g., username/password) directly to the
206 OpenDaylight controller token endpoint /oauth2/token and receives an access
207 token, which then can be used to access protected resources on the controller.
209 Configuring TokenAuthRealm
210 ~~~~~~~~~~~~~~~~~~~~~~~~~~
212 The TokenAuthRealm stores IdM data in an h2 database on each node. Thus,
213 configuration of a cluster currently requires configuring the desired IdM policy
214 on each node. There are two supported methods to manipulate the TokenAuthRealm
217 - idmtool configuration tool
219 - RESTful Web Service configuration
224 A utility script located at “etc/idmtool” is used to manipulate the
225 TokenAuthRealm IdM policy. idmtool assumes a single domain, the default one
226 (sdn), since multiple domains are not supported in the Boron release. General
227 usage information for idmtool is derived through issuing the following command:
231 $ python etc/idmtool -h
232 usage: idmtool [-h] [--target-host TARGET_HOST]
234 {list-users,add-user,change-password,delete-user,list-domains,list-roles,add-role,delete-role,add-grant,get-grants,delete-grant}
237 positional arguments:
238 user username for BSC node
239 {list-users,add-user,change-password,delete-user,list-domains,list-roles,add-role,delete-role,add-grant,get-grants,delete-grant}
241 list-users list all users
243 change-password change a password
244 delete-user delete a user
245 list-domains list all domains
246 list-roles list all roles
248 delete-role delete a role
249 add-grant add a grant
250 get-grants get grants for userid on sdn
251 delete-grant delete a grant
254 -h, --help show this help message and exit
255 --target-host TARGET_HOST
263 python etc/idmtool admin add-user newUser
278 "password": "**********",
279 "salt": "**********",
280 "userid": "newUser@sdn"
285 AAA redacts the password and salt fields for security purposes.
292 $ python etc/idmtool admin delete-user newUser@sdn
294 delete_user(newUser@sdn)
303 $ python etc/idmtool admin list-users
313 "description": "user user",
318 "password": "**********",
319 "salt": "**********",
323 "description": "admin user",
328 "password": "**********",
329 "salt": "**********",
330 "userid": "admin@sdn"
335 Change a user’s password
336 ''''''''''''''''''''''''
340 $ python etc/idmtool admin change-password admin@sdn
344 change_password(admin)
350 "description": "admin user",
355 "password": "**********",
356 "salt": "**********",
357 "userid": "admin@sdn"
365 $ python etc/idmtool admin add-role network-admin
367 add_role(network-admin)
375 "name": "network-admin",
376 "roleid": "network-admin@sdn"
384 $ python etc/idmtool admin delete-role network-admin@sdn
386 delete_role(network-admin@sdn)
395 $ python etc/idmtool admin list-roles
405 "description": "a role for admins",
408 "roleid": "admin@sdn"
411 "description": "a role for users",
424 $ python etc/idmtool admin list-domains
434 "description": "default odl sdn domain",
447 $ python etc/idmtool admin add-grant user@sdn admin@sdn
449 add_grant(userid=user@sdn,roleid=admin@sdn)
456 "grantid": "user@sdn@admin@sdn@sdn",
457 "roleid": "admin@sdn",
466 $ python etc/idmtool admin delete-grant user@sdn admin@sdn
468 http://localhost:8181/auth/v1/domains/sdn/users/user@sdn/roles/admin@sdn
469 delete_grant(userid=user@sdn,roleid=admin@sdn)
473 Get grants for a user
474 '''''''''''''''''''''
478 python etc/idmtool admin get-grants admin@sdn
480 get_grants(admin@sdn)
488 "description": "a role for users",
494 "description": "a role for admins",
497 "roleid": "admin@sdn"
502 **Configuration using the RESTful Web Service**
503 ###############################################
505 The TokenAuthRealm IdM policy is fully configurable through a RESTful
506 web service. Full documentation for manipulating AAA IdM data is located
507 online (https://wiki.opendaylight.org/images/0/00/AAA_Test_Plan.docx),
508 and a few examples are included in this guide:
515 curl -u admin:admin http://localhost:8181/auth/v1/users
520 "description": "user user",
525 "password": "**********",
526 "salt": "**********",
530 "description": "admin user",
535 "password": "**********",
536 "salt": "**********",
537 "userid": "admin@sdn"
547 curl -u admin:admin -X POST -H "Content-Type: application/json" --data-binary @./user.json http://localhost:8181/auth/v1/users
553 "description": "Ryan's User Account",
554 "email": "ryandgoulding@gmail.com"
561 "description":"Ryan's User Account",
563 "email":"ryandgoulding@gmail.com",
564 "password":"**********",
569 Create an OAuth2 Token For Admin Scoped to SDN
570 ''''''''''''''''''''''''''''''''''''''''''''''
574 curl -d 'grant_type=password&username=admin&password=a&scope=sdn' http://localhost:8181/oauth2/token
579 "token_type":"Bearer",
580 "access_token":"5a615fbc-bcad-3759-95f4-ad97e831c730"
588 curl -H "Authorization: Bearer 5a615fbc-bcad-3759-95f4-ad97e831c730" http://localhost:8181/auth/v1/domains
595 "description":"default odl sdn domain",
601 **Token Store Configuration Parameters**
602 ########################################
604 Edit the file “etc/opendaylight/karaf/08-authn-config.xml” and edit the
605 following: .\ **timeToLive**: Configure the maximum time, in milliseconds,
606 that tokens are to be cached. Default is 360000. Save the file.
614 LDAP integration is provided in order to externalize identity
615 management. This configuration allows federation with an external LDAP server.
616 The user’s OpenDaylight role parameters are mapped to corresponding LDAP
617 attributes as specified by the groupRolesMap. Thus, an LDAP operator can
618 provision attributes for LDAP users that support different OpenDaylight role
621 Configuring ODLJndiLdapRealm
622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
624 To configure LDAP parameters, modify "etc/shiro.ini"
625 parameters to include the ODLJndiLdapRealm:
629 # OpenDaylight provides a few LDAP implementations, which are disabled out of the box.
630 # ODLJndiLdapRealm includes authorization functionality based on LDAP elements
631 # extracted through and LDAP search. This requires a bit of knowledge about
632 # how your LDAP system is setup. An example is provided below:
633 ldapRealm = org.opendaylight.aaa.shiro.realm.ODLJndiLdapRealm
634 ldapRealm.userDnTemplate = uid={0},ou=People,dc=DOMAIN,dc=TLD
635 ldapRealm.contextFactory.url = ldap://<URL>:389
636 ldapRealm.searchBase = dc=DOMAIN,dc=TLD
637 ldapRealm.ldapAttributeForComparison = objectClass
638 ldapRealm.groupRolesMap = "Person":"admin"
640 # further down in the file...
641 # Stacked realm configuration; realms are round-robbined until authentication succeeds or realm sources are exhausted.
642 securityManager.realms = $tokenAuthRealm, $ldapRealm
644 ODLJndiLdapRealmAuthNOnly
645 ^^^^^^^^^^^^^^^^^^^^^^^^^
650 This is useful for setups where all LDAP users are allowed equal access.
652 Configuring ODLJndiLdapRealmAuthNOnly
653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
655 Edit the "etc/shiro.ini" file and modify the following:
659 ldapRealm = org.opendaylight.aaa.shiro.realm.ODLJndiLdapRealm
660 ldapRealm.userDnTemplate = uid={0},ou=People,dc=DOMAIN,dc=TLD
661 ldapRealm.contextFactory.url = ldap://<URL>:389
663 # further down in the file...
664 # Stacked realm configuration; realms are round-robbined until authentication succeeds or realm sources are exhausted.
665 securityManager.realms = $tokenAuthRealm, $ldapRealm
673 This realm authenticates OpenDaylight users against the OpenStack's Keystone
674 server. This realm uses the
675 `Keystone's Identity API v3 <https://developer.openstack.org/api-ref/identity/v3/>`_
678 .. figure:: ./images/aaa/keystonerealm-authentication.png
679 :alt: KeystoneAuthRealm authentication mechanism
681 KeystoneAuthRealm authentication/authorization mechanism
683 As can shown on the above diagram, once configured, all the RESTCONF APIs calls
684 will require sending **user**, **password** and optionally **domain** (1). Those
685 credentials are used to authenticate the call against the Keystone server (2) and,
686 if the authentication succeeds, the call will proceed to the MDSAL (3). The
687 credentials must be provisioned in advance within the Keystone Server. The user
688 and password are mandatory, while the domain is optional, in case it is not
689 provided within the REST call, the realm will default to (**Default**),
690 which is hard-coded. The default domain can be also configured through the
691 *shiro.ini* file (see the :doc:`AAA User Guide <user-guide>`).
693 The protocol between the Controller and the Keystone Server (2) can be either
694 HTTPS or HTTP. In order to use HTTPS the Keystone Server's certificate
695 must be exported and imported on the Controller (see the :ref:`Certificate Management <certificate-management>` section).
697 Configuring KeystoneAuthRealm
698 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
700 Edit the "etc/shiro.ini" file and modify the following:
704 # The KeystoneAuthRealm allows for authentication/authorization against an
705 # OpenStack's Keystone server. It uses the Identity's API v3 or later.
706 keystoneAuthRealm = org.opendaylight.aaa.shiro.realm.KeystoneAuthRealm
707 # The URL where the Keystone server exposes the Identity's API v3 the URL
708 # can be either HTTP or HTTPS and it is mandatory for this realm.
709 keystoneAuthRealm.url = https://<host>:<port>
710 # Optional parameter to make the realm verify the certificates in case of HTTPS
711 #keystoneAuthRealm.sslVerification = true
712 # Optional parameter to set up a default domain for requests using credentials
713 # without domain, uncomment in case you want a different value from the hard-coded
715 #keystoneAuthRealm.defaultDomain = Default
717 Once configured the realm, the mandatory fields are the fully quallified name of
718 the class implementing the realm *keystoneAuthRealm* and the endpoint where the
719 Keystone Server is listening *keystoneAuthRealm.url*.
721 The optional parameter *keystoneAuthRealm.sslVerification* specifies whether the
722 realm has to verify the SSL certificate or not. The optional parameter
723 *keystoneAuthRealm.defaultDomain* allows to use a different default domain from
724 the hard-coded one *"Default"*.
726 Authorization Configuration
727 ---------------------------
729 OpenDaylight supports two authorization engines at present, both of which are
730 roughly similar in behavior:
732 - Shiro-Based Authorization
734 - MDSAL-Based Dynamic Authorization
738 The preferred mechanism for configuring AAA Authentication is the
739 MDSAL-Based Dynamic Authorization. Read the following section.
741 Shiro-Based Static Authorization
742 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
744 OpenDaylight AAA has support for Role Based Access Control (RBAC) based
745 on the Apache Shiro permissions system. Configuration of the authorization
746 system is done off-line; authorization currently cannot be configured
747 after the controller is started. The Authorization provided by this mechanism
748 is aimed towards supporting coarse-grained security policies, the MDSAL-Based
749 mechanism allows for a more robust configuration capabilities. `Shiro-based
750 Authorization <http://shiro.apache.org/web.html#Web-%7B%7B%5Curls%5C%7D%7D>`_
751 describes how to configure the Authentication feature in detail.
755 The Shiro-Based Authorization that uses the *shiro.ini* URLs section to
756 define roles requirements is **deprecated** and **discouraged** since the
757 changes made to the file are only honored on a controller restart.
759 Shiro-Based Authorization is not **cluster-aware**, so the changes made on
760 the *shiro.ini* file have to be replicated on every controller instance
761 belonging to the cluster.
763 The URL patterns are matched relative to the Servlet context leaving room
764 for ambiguity, since many endpoints may match (i.e., "/restconf/modules" and
765 "/auth/modules" would both match a "/modules/\**" rule).
767 Enable “admin” Role Based Access to the IdMLight RESTful web service
768 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
770 Edit the “etc/shiro.ini” configuration file and add “/auth/v1/\**=
771 authcBasic, roles[admin]” above the line “/\** = authcBasic” within the
776 /auth/v1/** = authcBasic, roles[admin]
779 This will restrict the idmlight rest endpoints so that a grant for admin
780 role must be present for the requesting user.
784 The ordering of the authorization rules above is important!
786 MDSAL-Based Dynamic Authorization
787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
788 The MDSAL-Based Dynamic authorization uses the MDSALDynamicAuthorizationFilter
789 engine to restrict access to particular URL endpoint patterns. Users may define
790 a list of policies that are insertion-ordered. Order matters for that list of
791 policies, since the first matching policy is applied. This choice was made to
792 emulate behavior of the Shiro-Based Authorization mechanism.
794 A **policy** is a key/value pair, where the key is a **resource**
795 (i.e., a "URL pattern") and the value is a list of **permissions** for the
796 resource. The following describes the various elements of a policy:
798 - **Resource**: the resource is a string URL pattern as outlined by
799 Apache Shiro. For more information, see http://shiro.apache.org/web.html.
801 - **Description**: an optional description of the URL endpoint and why it is
804 - **Permissions list**: a list of permissions for a particular policy. If more
805 than one permission exists in the permissions list they are evaluated using
806 logical "OR". A permission describes the prerequisites to perform HTTP
807 operations on a particular endpoint. The following describes the various
808 elements of a permission:
810 + **Role**: the role required to access the target URL endpoint.
811 + **Actions list**: a leaf-list of HTTP permissions that are allowed for a
812 Subject possessing the required role.
814 This an example on how to limit access to the modules endpoint:
819 put URL: /rests/data/aaa:http-authorization/policies
821 headers: Content-Type: application/json Accept: application/json
828 "aaa:resource": "/restconf/modules/**",
847 The above example locks down access to the modules endpoint (and any URLS
848 available past modules) to the "admin" role. Thus, an attempt from the OOB
849 *admin* user will succeed with 2XX HTTP status code, while an attempt from the
850 OOB *user* user will fail with HTTP status code 401, as the user *user* is not
851 granted the "admin" role.
853 Accounting Configuration
854 ------------------------
856 Accounting is handled through the standard slf4j logging mechanisms used by the
857 rest of OpenDaylight. Thus, one can control logging verbosity through
858 manipulating the log levels for individual packages and classes directly through
859 the Karaf console, JMX, or etc/org.ops4j.pax.logging.cfg. In normal operations,
860 the default levels exposed do not provide much information about AAA services;
861 this is due to the fact that logging can severely degrade performance.
863 All AAA logging is output to the standard karaf.log file. For debugging purposes
864 (i.e., to enable maximum verbosity), issue the following command:
868 log:set TRACE org.opendaylight.aaa
870 Enable Successful/Unsuccessful Authentication Attempts Logging
871 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
873 By default, successful/unsuccessful authentication attempts are NOT logged. This
874 is due to the fact that logging can severely decrease REST performance.
875 To enable logging of successful/unsuccessful REST attempts, issue the following
876 command in Karaf's console:
880 log:set DEBUG org.opendaylight.aaa.shiro.filters.AuthenticationListener
882 It is possible to add custom AuthenticationListener(s) to the Shiro-based
883 configuration, allowing different ways to listen for successful/unsuccessful
884 authentication attempts. Custom AuthenticationListener(s) must implement
885 the org.apache.shiro.authc.AuthenticationListener interface.
887 .. _certificate-management:
889 Certificate Management
890 ----------------------
892 The **Certificate Management Service** is used to manage the keystores and
893 certificates at the OpenDaylight distribution to easily provides the TLS
896 The Certificate Management Service managing two keystores:
898 1. **OpenDaylight Keystore** which holds the OpenDaylight distribution
899 certificate self sign certificate or signed certificate from a root CA based
900 on generated certificate request.
902 2. **Trust Keystore** which holds all the network nodes certificates that shall
903 to communicate with the OpenDaylight distribution through TLS communication.
905 The Certificate Management Service stores the keystores (OpenDaylight & Trust)
906 as *.jks* files under configuration/ssl/ directory. Also the keystores
907 could be stored at the MD-SAL datastore in case OpenDaylight distribution
908 running at cluster environment. When the keystores are stored at MD-SAL,
909 the Certificate Management Service rely on the **Encryption-Service** to encrypt
910 the keystore data before storing it to MD-SAL and decrypted at runtime.
912 How to use the Certificate Management Service to manage the TLS communication
913 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
915 The following are the steps to configure the TLS communication:
917 1. After starting the distribution, the *odl-aaa-cert* feature has to get
918 installed. Use the following command at Karaf CLI to check.
922 opendaylight-user@root>feature:list -i | grep aaa-cert
923 odl-aaa-cert | 0.5.0-SNAPSHOT | x | odl-aaa-0.5.0-SNAPSHOT | OpenDaylight :: AAA :: aaa certificate Service
925 2. The initial configuration of the Certificate Manager Service exists under
926 the distribution directory etc/opendaylight/datastore/initial/config/aaa-cert-config.xml.
930 <aaa-cert-service-config xmlns="urn:opendaylight:yang:aaa:cert">
931 <use-config>false</use-config>
932 <use-mdsal>false</use-mdsal>
933 <bundle-name>opendaylight</bundle-name>
936 <alias>controller</alias>
938 <dname>CN=ODL, OU=Dev, O=LinuxFoundation, L=QC Montreal, C=CA</dname>
939 <validity>365</validity>
940 <key-alg>RSA</key-alg>
941 <sign-alg>SHA1WithRSAEncryption</sign-alg>
942 <keysize>1024</keysize>
948 <name>truststore.jks</name>
951 </aaa-cert-service-config>
954 Now as it is explained above, the Certificate Manager Service support two mode
955 of operations; cluster mode and single mode. To use the single mode change the
956 use-config to true and it is recommended as long as there is no need for
957 cluster environment. To use the cluster mode change the use-config and
958 use-mdsal configurations to true and the keystores will be stored and shard
959 across the cluster nodes within the MD-SAL datastore.
961 The initial password become randomly generated when the *aaa-cert* feature is
964 The cipher suites can be restricted by changing the **<cipher-suites>**
965 configuration, however, the JDK has to be upgraded by installing the `Java
966 Cryptography Extension
967 <http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html>`_
973 <suite-name>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</suite-name>
976 <suite-name>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</suite-name>
979 <suite-name>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</suite-name>
982 3. The new configurations will take affect after restarting the distribution.
984 4. Now to add or get certificate to the OpenDaylight and Trust keystores, the
985 Certificate Manager Service provides the following RPCs.
989 a) Set the node certificate that will communicate with OpeDaylight through TLS
991 POST /operations/aaa-cert-rpc:setNodeCertifcate
994 "node-cert": "string",
995 "node-alias": "string"
1001 b) Get the node certificate based on node alias.
1002 POST /operations/aaa-cert-rpc:getNodeCertifcate
1005 "node-alias": "string"
1011 c) Get the OpeDaylight keystore certificate.
1012 POST /operations/aaa-cert-rpc:getODLCertificate
1021 d) Generate a certificate request from the OpeDaylight keystore to be signed
1023 POST /operations/aaa-cert-rpc:getODLCertificateReq
1026 odl-cert-req "string"
1032 e) Set the OpeDaylight certificate, the certificate should be generated
1033 based on a certificate request generated from the ODL keystore otherwise the
1034 certificated will not be added.
1035 POST /operations/aaa-cert-rpc:setODLCertificate
1038 "odl-cert-alias": "string",
1039 "odl-cert": "string"
1045 The Certificate Manager Service RPCs are allowed only to the Role Admin Users
1046 and it could be completely disabled through the shiro.ini config file. Check
1047 the URL section at the shiro.ini.
1052 The **AAA Encryption Service** is used to encrypt the OpenDaylight's users'
1053 passwords and TLS communication certificates. This section shows how to use the
1054 AAA Encryption Service with an OpenDaylight distribution project to encrypt data.
1056 The following are the steps to configure the Encryption Service:
1058 1. After starting the distribution, the *aaa-encryption-service* feature has to
1059 get installed. Use the following command at Karaf CLI to check.
1061 .. code-block:: bash
1063 opendaylight-user@root>feature:list -i | grep aaa-encryption-service
1064 odl-aaa-encryption-service | 0.5.0-SNAPSHOT | x | odl-aaa-0.5.0-SNAPSHOT | OpenDaylight :: AAA :: Encryption Service
1066 2. The initial configuration of the Encryption Service exists under the
1067 distribution directory etc/opendaylight/datastore/initial/config/aaa-encrypt-service-config.xml
1071 <aaa-encrypt-service-config xmlns="config:aaa:authn:encrypt:service:config">
1074 <encrypt-method>PBKDF2WithHmacSHA1</encrypt-method>
1075 <encrypt-type>AES</encrypt-type>
1076 <encrypt-iteration-count>32768</encrypt-iteration-count>
1077 <encrypt-key-length>128</encrypt-key-length>
1078 <cipher-transforms>AES/CBC/PKCS5Padding</cipher-transforms>
1079 </aaa-encrypt-service-config>
1083 Both the initial encryption key and encryption salt become randomly generated
1084 when the *aaa-encryption-service* feature is installed.
1086 3. Finally the new configurations will take affect after restarting the
1089 Using the AAA Command Line Interface (CLI)
1090 ------------------------------------------
1091 The AAA offers a CLI through the Karaf's console. This CLI allows the user to
1092 configure and use some of the functionalities provided by AAA.
1094 The AAA CLI exists under the **odl-aaa-cli** feature. This feature can be
1095 installed by executing the following command.
1099 feature:install odl-aaa-cli
1101 To check that the installation of the feature succeeded type "aaa" and press
1102 *tab* to see the list of available commands under the *aaa* scope.
1106 opendaylight-user@root>aaa:
1107 aaa:add-domain aaa:add-grant aaa:add-role aaa:add-user
1108 aaa:change-user-pwd aaa:export-keystores aaa:gen-cert-req aaa:get-cipher-suites
1109 aaa:get-domains aaa:get-node-cert aaa:get-odl-cert aaa:get-roles
1110 aaa:get-tls-protocols aaa:get-users aaa:import-keystores aaa:remove-domain
1111 aaa:remove-grant aaa:remove-role aaa:remove-user
1116 The *add-user* command allows for adding an OpenDaylight user. The following
1117 user parameters can be specified.
1121 aaa:add-user --userName <user name>
1123 --userDescription <user description>
1124 --userEmail <user email>
1125 --domainName <domain name>
1127 List available Users
1128 ^^^^^^^^^^^^^^^^^^^^
1130 The *get-users* command list all the available users within the Controller.
1142 The *remove-user* command allows for removing an OpenDaylight user. The command
1143 needs the user name as parameter.
1147 aaa:remove-user --name <user name>
1149 Change the OpenDaylight user password
1150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1152 The *change-user-pwd* command allows for changing the OpenDaylight user's
1153 password. It takes the user name as argument then will ask for the given user
1158 aaa:change-user-pwd --userName admin
1159 Enter current password:
1161 admin's password has been changed
1166 The *add-role* command allows for adding a role to the Controller.
1170 aaa:add-role --roleName <role name>
1171 --roleDescription <role description>
1172 --domainName <domain name>
1174 List available Roles
1175 ^^^^^^^^^^^^^^^^^^^^
1177 The *get-roles* command list all the available roles within the controller.
1189 The *remove-role* command allows for removing an OpenDaylight role. The command
1190 needs the role name as parameter. The role will be removed from those users who
1195 aaa:remove-role --roleName <role name>
1200 The *add-domain* command allows for adding a domain to the Controller.
1204 aaa:add-domain --domainName <domain name>
1205 --domainDescription <domain description>
1207 List available Domains
1208 ^^^^^^^^^^^^^^^^^^^^^^
1210 The *get-domains* command list all the available domains within the controller.
1211 The system asks for the administrator credentials to execute this command.
1222 The *remove-domain* command allows for removing an OpenDaylight role. The command
1223 needs the domain name as parameter.
1227 aaa:remove-domain --domainName <domain name>
1232 The *add-grant* command allows for creating a grant for an existing user. The
1233 command returns a grant id for that user.
1237 aaa:add-grant --userName <user name>
1238 --domainName <domain name>
1239 --roleName <role name>
1244 The *remove-grant* command allows for removing an OpenDaylight grant. This command
1245 needs the user name, domain and and role as parameters.
1249 aaa:remove-grant --userName <user name>
1250 --domainName <domain name>
1251 --roleName <role name>
1253 Generate Certificate Request
1254 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1256 Generate certificate request command will generate a certificate request based
1257 on the generated OpenDaylight keystore and print it on the Karaf CLI. The system
1258 asks for the keystore password.
1264 -----BEGIN CERTIFICATE REQUEST-----
1265 MIIBlzCCAQACAQAwWTELMAkGA1UEBhMCQ0ExFDASBgNVBAcMC1FDIE1vbnRyZWFsMRgwFgYDVQQKDA
1266 9MaW51eEZvdW5kYXRpb24xDDAKBgNVBAsMA0RldjEMMAoGA1UEAwwDT0RMMIGfMA0GCSqGSIb3DQEB
1267 AQUAA4GNADCBiQKBgQCCmLW6j+JLYJM5yAMwscw/CHqPnp5elPa1YtQsHKEAvp1I+mLVtHKZeXeteA
1268 kyp6ORxw6KQ515fcDyQVrRJiSM15jUd27UaFq5ku0+qJeG+Qh2btx+cvNSE7/+cgUWWosKz4Aff5F5
1269 FqR62jLUTNzqCvoaTbZaOnLYVq+O2dYyZwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBADhDr4Jm7gVm/o
1270 p861/FShyw1ZZscxOEl2TprJZiTO6sn3sLptQZv8v52Z+Jm5dAgr7L46c97Xfa+0j6Y4LXNb0f88lL
1271 RG8PxGbk6Tqbjqc0WS+U1Ibc/rcPK4HEN/bcYCn+Na1gLBaFXUPg08ozG6MwqFNeS5Z0jz1W0D9/oiao
1272 -----END CERTIFICATE REQUEST-----
1274 Get OpenDaylight Certificate
1275 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1277 The *get-odl-certificate* command will print the OpenDaylight certificate at the
1278 Karaf CLI. The system asks for the keystore password.
1282 aaa:get-odl-cert -storepass <store_password>
1284 -----BEGIN CERTIFICATE-----
1285 MIICKTCCAZKgAwIBAgIEI75RWDANBgkqhkiG9w0BAQUFADBZMQwwCgYDVQQDDANPREwxDDAKBgNVBA
1286 sMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVhbDELMAkG
1287 A1UEBhMCQ0EwHhcNMTYxMTMwMTYyNDE3WhcNMTcxMTMwMTYyNDE3WjBZMQwwCgYDVQQDDANPREwxDD
1288 AKBgNVBAsMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVh
1289 bDELMAkGA1UEBhMCQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAIKYtbqP4ktgkznIAzCxzD
1290 8Ieo+enl6U9rVi1CwcoQC+nUj6YtW0cpl5d614CTKno5HHDopDnXl9wPJBWtEmJIzXmNR3btRoWrmS
1291 7T6ol4b5CHZu3H5y81ITv/5yBRZaiwrPgB9/kXkWpHraMtRM3OoK+hpNtlo6cthWr47Z1jJnAgMBAA
1292 EwDQYJKoZIhvcNAQEFBQADgYEAL9DK/P/yEBre3Mg3bICAUAvSvZic+ydDmigWLsY4J3UzKdV2f1jI
1293 s+rQTEgtlHShBf/ed546D49cp3XEzYrcxgILhGXDziCrUK0K1TiYqPTp6FLijjdydGlPpwuMyyV5Y0
1294 iDiRclWuPz2fHbs8WQOWNs6VQ+WaREXtEsEC4qgSo=
1295 -----END CERTIFICATE-----
1300 The *get-cipher-suites* command shows the cipher suites supported by the
1301 JVM used by the OpenDaylight controller in TLS communication. For example, here
1302 are the `Default Ciphers Suites in JDK 8 <http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites>`_.
1306 aaa:get-cipher-suites
1308 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1309 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1310 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1315 The *get-tls-protocols* command shows the TLS protocols supported by the
1316 JVM used by the OpenDaylight controller. For example, the JDK 8 supports the
1317 following TLS protocols: TLSv1.2 (default), TLSv1.1, TLSv1 and SSLv3.
1321 aaa:get-tls-protocols
1323 TLS_KRB5_WITH_RC4_128_SHA
1324 TLS_KRB5_WITH_RC4_128_MD5
1325 TLS_KRB5_WITH_3DES_EDE_CBC_SHA
1326 TLS_KRB5_WITH_3DES_EDE_CBC_MD5
1327 TLS_KRB5_WITH_DES_CBC_SHA
1329 Get Node Certificate
1330 ^^^^^^^^^^^^^^^^^^^^
1332 The *get-node-cert* command prints a certificate for a given network node alias.
1333 This command is useful to check if the network node certificate has been added
1334 properly to the truest keystore. It takes the certificate alias as arguments.
1338 aaa:get-node-cert -alias ovs1
1339 -----BEGIN CERTIFICATE-----
1340 MIICKTCCAZKgAwIBAgIEI75RWDANBgkqhkiG9w0BAQUFADBZMQwwCgYDVQQDDANPREwxDDAKBgNVBA
1341 sMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVhbDELMAkG
1342 A1UEBhMCQ0EwHhcNMTYxMTMwMTYyNDE3WhcNMTcxMTMwMTYyNDE3WjBZMQwwCgYDVQQDDANPREwxDD
1343 AKBgNVBAsMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVh
1344 bDELMAkGA1UEBhMCQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAIKYtbqP4ktgkznIAzCxzD
1345 8Ieo+enl6U9rVi1CwcoQC+nUj6YtW0cpl5d614CTKno5HHDopDnXl9wPJBWtEmJIzXmNR3btRoWrmS
1346 7T6ol4b5CHZu3H5y81ITv/5yBRZaiwrPgB9/kXkWpHraMtRM3OoK+hpNtlo6cthWr47Z1jJnAgMBAA
1347 EwDQYJKoZIhvcNAQEFBQADgYEAL9DK/P/yEBre3Mg3bICAUAvSvZic+ydDmigWLsY4J3UzKdV2f1jI
1348 s+rQTEgtlHShBf/ed546D49cp3XEzYrcxgILhGXDziCrUK0K1TiYqPTp6FLijjdydGlPpwuMyyV5Y0
1349 iDiRclWuPz2fHbs8WQOWNs6VQ+WaREXtEsEC4qgSo=
1350 -----END CERTIFICATE-----
1355 The *export-keystores* command exports the default MD-SAL Keystores to .jks
1356 files in the default directory for keystores (configuration/ssl/).
1360 aaa:export-keystores
1362 Default directory for keystores is configuration/ssl/
1367 The *import-keystores* command imports the default MD-SAL Keystores. The
1368 keystores (odl and trust) should exist under default SSL directory
1369 (configuration/ssl/).
1371 .. code-block:: bash
1373 aaa:import-keystores --trustKeystoreName <name of the trust keystore>
1374 --trustKeystorePwd <password for the trust keystore>
1375 --odlKeystoreName <name of the ODL keystore>
1376 --odlKeystorePwd <password for the ODL keystore>
1377 --odlKeystoreAlias <alias of the ODL keystore>
1378 --tlsProtocols <list of TLS protocols separated by ','>
1379 --cipherSuites <list of Cipher suites separated by ','>
1383 It is strongly recommended to run the history clear command after you execute
1384 all the AAA CLI commands so Karaf logs stay clean from any adversary.