docs/user-guide/authentication-and-authorization-services.rst

   1 .. _aaa-user-guide:
   2
   3 Authentication, Authorization and Accounting (AAA) Services
   4 ===========================================================
   5
   6 Overview
   7 --------
   8
   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.
  13
  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.
  21
  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.
  26
  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.
  30
  31 Terms And Definitions
  32 ^^^^^^^^^^^^^^^^^^^^^
  33
  34 AAA
  35     Authentication, Authorization and Accounting.
  36
  37 Token
  38     A claim of access to a group of resources on the controller.
  39
  40 Domain
  41     A group of resources, direct or indirect, physical, logical, or
  42     virtual, for the purpose of access control.
  43
  44 User
  45     A person who either owns or has access to a resource or group of
  46     resources on the controller.
  47
  48 Role
  49     Opaque representation of a set of permissions, which is merely a
  50     unique string as admin or guest.
  51
  52 Credential
  53     Proof of identity such as user name and password, OTP, biometrics, or
  54     others.
  55
  56 Client
  57     A service or application that requires access to the controller.
  58
  59 Claim
  60     A data set of validated assertions regarding a user, e.g. the role,
  61     domain, name, etc.
  62
  63 Grant
  64     It is the entity associating a user with his role and domain.
  65
  66 IdP
  67     Identity Provider.
  68
  69 TLS
  70     Transport Layer Security
  71
  72 CLI
  73     Command Line Interface
  74
  75 Security Framework for AAA services
  76 -----------------------------------
  77
  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.
  82
  83
  84 How to enable AAA
  85 -----------------
  86
  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.
  92
  93 How to disable AAA
  94 ------------------
  95
  96 Edit the “etc/shiro.ini” file and replace the following:
  97
  98 ::
  99
 100     /** = authcBasic
 101
 102 with
 103
 104 ::
 105
 106     /** = anon
 107
 108 Then restart the Karaf process.
 109
 110 AAA Realms
 111 ----------
 112
 113 AAA plugin utilizes the Shiro Realms to support pluggable authentication &
 114 authorization schemes. There are two parent types of realms:
 115
 116 -  AuthenticatingRealm
 117
 118    -  Provides no Authorization capability.
 119
 120    -  Users authenticated through this type of realm are treated
 121       equally.
 122
 123 -  AuthorizingRealm
 124
 125    -  AuthorizingRealm is a more sophisticated AuthenticatingRealm,
 126       which provides the additional mechanisms to distinguish users
 127       based on roles.
 128
 129    -  Useful for applications in which roles determine allowed
 130       capabilities.
 131
 132 OpenDaylight contains five implementations:
 133
 134 -  TokenAuthRealm
 135
 136    -  An AuthorizingRealm built to bridge the Shiro-based AAA service
 137       with the h2-based AAA implementation.
 138
 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
 142       of band method.
 143
 144    -  A python script located at “etc/idmtool” is included to help
 145       manipulate data contained in the TokenAuthRealm.
 146
 147    -  Enabled out of the box. This is the realm configured by default.
 148
 149 -  ODLJndiLdapRealm
 150
 151    -  An AuthorizingRealm built to extract identity information from IdM
 152       data contained on an LDAP server.
 153
 154    -  Extracts group information from LDAP, which is translated into
 155       OpenDaylight roles.
 156
 157    -  Useful when federating against an existing LDAP server, in which
 158       only certain types of users should have certain access privileges.
 159
 160    -  Disabled out of the box.
 161
 162 -  ODLJndiLdapRealmAuthNOnly
 163
 164    -  The same as ODLJndiLdapRealm, except without role extraction.
 165       Thus, all LDAP users have equal authentication and authorization
 166       rights.
 167
 168    -  Disabled out of the box.
 169
 170 -  ODLActiveDirectoryRealm
 171
 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.
 175
 176 -  KeystoneAuthRealm
 177
 178    - This realm authenticates OpenDaylight users against the OpenStack’s
 179      Keystone server.
 180
 181    - Disabled out of the box.
 182
 183 .. note::
 184
 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.
 189
 190 TokenAuthRealm
 191 ^^^^^^^^^^^^^^
 192
 193 How it works
 194 ~~~~~~~~~~~~
 195
 196 The TokenAuthRealm is the default Authorization Realm deployed in OpenDaylight.
 197 TokenAuthRealm uses a direct authentication mechanism as shown in the following
 198 picture:
 199
 200 .. figure:: ./images/aaa/direct-authentication.png
 201    :alt: TokenAuthRealm direct authentication mechanism
 202
 203    TokenAuthRealm direct authentication mechanism
 204
 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.
 208
 209 Configuring TokenAuthRealm
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 211
 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
 215 IdM configuration:
 216
 217 -  idmtool configuration tool
 218
 219 -  RESTful Web Service configuration
 220
 221 **Idmtool**
 222 ###########
 223
 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:
 228
 229 ::
 230
 231     $ python etc/idmtool -h
 232     usage: idmtool [-h] [--target-host TARGET_HOST]
 233                    user
 234                    {list-users,add-user,change-password,delete-user,list-domains,list-roles,add-role,delete-role,add-grant,get-grants,delete-grant}
 235                    ...
 236
 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}
 240                             sub-command help
 241         list-users          list all users
 242         add-user            add a user
 243         change-password     change a password
 244         delete-user         delete a user
 245         list-domains        list all domains
 246         list-roles          list all roles
 247         add-role            add a role
 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
 252
 253     optional arguments:
 254       -h, --help            show this help message and exit
 255       --target-host TARGET_HOST
 256                             target host node
 257
 258 Add a user
 259 ''''''''''
 260
 261 ::
 262
 263     python etc/idmtool admin add-user newUser
 264     Password:
 265     Enter new password:
 266     Re-enter password:
 267     add_user(admin)
 268
 269     command succeeded!
 270
 271     json:
 272     {
 273         "description": "",
 274         "domainid": "sdn",
 275         "email": "",
 276         "enabled": true,
 277         "name": "newUser",
 278         "password": "**********",
 279         "salt": "**********",
 280         "userid": "newUser@sdn"
 281     }
 282
 283 .. note::
 284
 285     AAA redacts the password and salt fields for security purposes.
 286
 287 Delete a user
 288 '''''''''''''
 289
 290 ::
 291
 292     $ python etc/idmtool admin delete-user newUser@sdn
 293     Password:
 294     delete_user(newUser@sdn)
 295
 296     command succeeded!
 297
 298 List all users
 299 ''''''''''''''
 300
 301 ::
 302
 303     $ python etc/idmtool admin list-users
 304     Password:
 305     list_users
 306
 307     command succeeded!
 308
 309     json:
 310     {
 311         "users": [
 312             {
 313                 "description": "user user",
 314                 "domainid": "sdn",
 315                 "email": "",
 316                 "enabled": true,
 317                 "name": "user",
 318                 "password": "**********",
 319                 "salt": "**********",
 320                 "userid": "user@sdn"
 321             },
 322             {
 323                 "description": "admin user",
 324                 "domainid": "sdn",
 325                 "email": "",
 326                 "enabled": true,
 327                 "name": "admin",
 328                 "password": "**********",
 329                 "salt": "**********",
 330                 "userid": "admin@sdn"
 331             }
 332         ]
 333     }
 334
 335 Change a user’s password
 336 ''''''''''''''''''''''''
 337
 338 ::
 339
 340     $ python etc/idmtool admin change-password admin@sdn
 341     Password:
 342     Enter new password:
 343     Re-enter password:
 344     change_password(admin)
 345
 346     command succeeded!
 347
 348     json:
 349     {
 350         "description": "admin user",
 351         "domainid": "sdn",
 352         "email": "",
 353         "enabled": true,
 354         "name": "admin",
 355         "password": "**********",
 356         "salt": "**********",
 357         "userid": "admin@sdn"
 358     }
 359
 360 Add a role
 361 ''''''''''
 362
 363 ::
 364
 365     $ python etc/idmtool admin add-role network-admin
 366     Password:
 367     add_role(network-admin)
 368
 369     command succeeded!
 370
 371     json:
 372     {
 373         "description": "",
 374         "domainid": "sdn",
 375         "name": "network-admin",
 376         "roleid": "network-admin@sdn"
 377     }
 378
 379 Delete a role
 380 '''''''''''''
 381
 382 ::
 383
 384     $ python etc/idmtool admin delete-role network-admin@sdn
 385     Password:
 386     delete_role(network-admin@sdn)
 387
 388     command succeeded!
 389
 390 List all roles
 391 ''''''''''''''
 392
 393 ::
 394
 395     $ python etc/idmtool admin list-roles
 396     Password:
 397     list_roles
 398
 399     command succeeded!
 400
 401     json:
 402     {
 403         "roles": [
 404             {
 405                 "description": "a role for admins",
 406                 "domainid": "sdn",
 407                 "name": "admin",
 408                 "roleid": "admin@sdn"
 409             },
 410             {
 411                 "description": "a role for users",
 412                 "domainid": "sdn",
 413                 "name": "user",
 414                 "roleid": "user@sdn"
 415             }
 416         ]
 417     }
 418
 419 List all domains
 420 ''''''''''''''''
 421
 422 ::
 423
 424     $ python etc/idmtool admin list-domains
 425     Password:
 426     list_domains
 427
 428     command succeeded!
 429
 430     json:
 431     {
 432         "domains": [
 433             {
 434                 "description": "default odl sdn domain",
 435                 "domainid": "sdn",
 436                 "enabled": true,
 437                 "name": "sdn"
 438             }
 439         ]
 440     }
 441
 442 Add a grant
 443 '''''''''''
 444
 445 ::
 446
 447     $ python etc/idmtool admin add-grant user@sdn admin@sdn
 448     Password:
 449     add_grant(userid=user@sdn,roleid=admin@sdn)
 450
 451     command succeeded!
 452
 453     json:
 454     {
 455         "domainid": "sdn",
 456         "grantid": "user@sdn@admin@sdn@sdn",
 457         "roleid": "admin@sdn",
 458         "userid": "user@sdn"
 459     }
 460
 461 Delete a grant
 462 ''''''''''''''
 463
 464 ::
 465
 466     $ python etc/idmtool admin delete-grant user@sdn admin@sdn
 467     Password:
 468     http://localhost:8181/auth/v1/domains/sdn/users/user@sdn/roles/admin@sdn
 469     delete_grant(userid=user@sdn,roleid=admin@sdn)
 470
 471     command succeeded!
 472
 473 Get grants for a user
 474 '''''''''''''''''''''
 475
 476 ::
 477
 478     python etc/idmtool admin get-grants admin@sdn
 479     Password:
 480     get_grants(admin@sdn)
 481
 482     command succeeded!
 483
 484     json:
 485     {
 486         "roles": [
 487             {
 488                 "description": "a role for users",
 489                 "domainid": "sdn",
 490                 "name": "user",
 491                 "roleid": "user@sdn"
 492             },
 493             {
 494                 "description": "a role for admins",
 495                 "domainid": "sdn",
 496                 "name": "admin",
 497                 "roleid": "admin@sdn"
 498             }
 499         ]
 500     }
 501
 502 **Configuration using the RESTful Web Service**
 503 ###############################################
 504
 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:
 509
 510 Get All Users
 511 '''''''''''''
 512
 513 ::
 514
 515     curl -u admin:admin http://localhost:8181/auth/v1/users
 516     OUTPUT:
 517     {
 518         "users": [
 519             {
 520                 "description": "user user",
 521                 "domainid": "sdn",
 522                 "email": "",
 523                 "enabled": true,
 524                 "name": "user",
 525                 "password": "**********",
 526                 "salt": "**********",
 527                 "userid": "user@sdn"
 528             },
 529             {
 530                 "description": "admin user",
 531                 "domainid": "sdn",
 532                 "email": "",
 533                 "enabled": true,
 534                 "name": "admin",
 535                 "password": "**********",
 536                 "salt": "**********",
 537                 "userid": "admin@sdn"
 538             }
 539         ]
 540     }
 541
 542 Create a User
 543 '''''''''''''
 544
 545 ::
 546
 547     curl -u admin:admin -X POST -H "Content-Type: application/json" --data-binary @./user.json http://localhost:8181/auth/v1/users
 548     PAYLOAD:
 549     {
 550         "name": "ryan",
 551         "userid": "ryan@sdn",
 552         "password": "ryan",
 553         "domainid": "sdn",
 554         "description": "Ryan's User Account",
 555         "email": "ryandgoulding@gmail.com"
 556     }
 557
 558     OUTPUT:
 559     {
 560         "userid":"ryan@sdn",
 561         "name":"ryan",
 562         "description":"Ryan's User Account",
 563         "enabled":true,
 564         "email":"ryandgoulding@gmail.com",
 565         "password":"**********",
 566         "salt":"**********",
 567         "domainid":"sdn"
 568     }
 569
 570 Create an OAuth2 Token For Admin Scoped to SDN
 571 ''''''''''''''''''''''''''''''''''''''''''''''
 572
 573 ::
 574
 575     curl -d 'grant_type=password&username=admin&password=a&scope=sdn' http://localhost:8181/oauth2/token
 576
 577     OUTPUT:
 578     {
 579         "expires_in":3600,
 580         "token_type":"Bearer",
 581         "access_token":"5a615fbc-bcad-3759-95f4-ad97e831c730"
 582     }
 583
 584 Use an OAuth2 Token
 585 '''''''''''''''''''
 586
 587 ::
 588
 589     curl -H "Authorization: Bearer 5a615fbc-bcad-3759-95f4-ad97e831c730" http://localhost:8181/auth/v1/domains
 590     {
 591         "domains":
 592         [
 593             {
 594                 "domainid":"sdn",
 595                 "name":"sdn”,
 596                 "description":"default odl sdn domain",
 597                 "enabled":true
 598             }
 599         ]
 600     }
 601
 602 **Token Store Configuration Parameters**
 603 ########################################
 604
 605 Edit the file “etc/opendaylight/karaf/08-authn-config.xml” and edit the
 606 following: .\ **timeToLive**: Configure the maximum time, in milliseconds,
 607 that tokens are to be cached. Default is 360000. Save the file.
 608
 609 ODLJndiLdapRealm
 610 ^^^^^^^^^^^^^^^^
 611
 612 How it works
 613 ~~~~~~~~~~~~
 614
 615 LDAP integration is provided in order to externalize identity
 616 management. This configuration allows federation with an external LDAP server.
 617 The user’s OpenDaylight role parameters are mapped to corresponding LDAP
 618 attributes as specified by the groupRolesMap. Thus, an LDAP operator can
 619 provision attributes for LDAP users that support different OpenDaylight role
 620 structures.
 621
 622 Configuring ODLJndiLdapRealm
 623 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 624
 625 To configure LDAP parameters, modify "etc/shiro.ini"
 626 parameters to include the ODLJndiLdapRealm:
 627
 628 ::
 629
 630     # OpenDaylight provides a few LDAP implementations, which are disabled out of the box.
 631     # ODLJndiLdapRealm includes authorization functionality based on LDAP elements
 632     # extracted through and LDAP search.  This requires a bit of knowledge about
 633     # how your LDAP system is setup.  An example is provided below:
 634     ldapRealm = org.opendaylight.aaa.shiro.realm.ODLJndiLdapRealm
 635     ldapRealm.userDnTemplate = uid={0},ou=People,dc=DOMAIN,dc=TLD
 636     ldapRealm.contextFactory.url = ldap://<URL>:389
 637     ldapRealm.searchBase = dc=DOMAIN,dc=TLD
 638     ldapRealm.ldapAttributeForComparison = objectClass
 639     ldapRealm.groupRolesMap = "Person":"admin"
 640     # ...
 641     # further down in the file...
 642     # Stacked realm configuration;  realms are round-robbined until authentication succeeds or realm sources are exhausted.
 643     securityManager.realms = $tokenAuthRealm, $ldapRealm
 644
 645 ODLJndiLdapRealmAuthNOnly
 646 ^^^^^^^^^^^^^^^^^^^^^^^^^
 647
 648 How it works
 649 ~~~~~~~~~~~~
 650
 651 This is useful for setups where all LDAP users are allowed equal access.
 652
 653 Configuring ODLJndiLdapRealmAuthNOnly
 654 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 655
 656 Edit the "etc/shiro.ini" file and modify the following:
 657
 658 ::
 659
 660     ldapRealm = org.opendaylight.aaa.shiro.realm.ODLJndiLdapRealm
 661     ldapRealm.userDnTemplate = uid={0},ou=People,dc=DOMAIN,dc=TLD
 662     ldapRealm.contextFactory.url = ldap://<URL>:389
 663     # ...
 664     # further down in the file...
 665     # Stacked realm configuration;  realms are round-robbined until authentication succeeds or realm sources are exhausted.
 666     securityManager.realms = $tokenAuthRealm, $ldapRealm
 667
 668 KeystoneAuthRealm
 669 ^^^^^^^^^^^^^^^^^
 670
 671 How it works
 672 ~~~~~~~~~~~~
 673
 674 This realm authenticates OpenDaylight users against the OpenStack's Keystone
 675 server. This realm uses the
 676 `Keystone's Identity API v3 <https://developer.openstack.org/api-ref/identity/v3/>`_
 677 or later.
 678
 679 .. figure:: ./images/aaa/keystonerealm-authentication.png
 680    :alt: KeystoneAuthRealm authentication mechanism
 681
 682    KeystoneAuthRealm authentication/authorization mechanism
 683
 684 As can shown on the above diagram, once configured, all the RESTCONF APIs calls
 685 will require sending **user**, **password** and optionally **domain** (1). Those
 686 credentials are used to authenticate the call against the Keystone server (2) and,
 687 if the authentication succeeds, the call will proceed to the MDSAL (3). The
 688 credentials must be provisioned in advance within the Keystone Server. The user
 689 and password are mandatory, while the domain is optional, in case it is not
 690 provided within the REST call, the realm will default to (**Default**),
 691 which is hard-coded. The default domain can be also configured through the
 692 *shiro.ini* file (see the :doc:`AAA User Guide <../user-guide/authentication-and-authorization-services>`).
 693
 694 The protocol between the Controller and the Keystone Server (2) can be either
 695 HTTPS or HTTP. In order to use HTTPS the Keystone Server's certificate
 696 must be exported and imported on the Controller (see the :ref:`Certificate Management <certificate-management>` section).
 697
 698 Configuring KeystoneAuthRealm
 699 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 700
 701 Edit the "etc/shiro.ini" file and modify the following:
 702
 703 ::
 704
 705     # The KeystoneAuthRealm allows for authentication/authorization against an
 706     # OpenStack's Keystone server. It uses the Identity's API v3 or later.
 707     keystoneAuthRealm = org.opendaylight.aaa.shiro.realm.KeystoneAuthRealm
 708     # The URL where the Keystone server exposes the Identity's API v3 the URL
 709     # can be either HTTP or HTTPS and it is mandatory for this realm.
 710     keystoneAuthRealm.url = https://<host>:<port>
 711     # Optional parameter to make the realm verify the certificates in case of HTTPS
 712     #keystoneAuthRealm.sslVerification = true
 713     # Optional parameter to set up a default domain for requests using credentials
 714     # without domain, uncomment in case you want a different value from the hard-coded
 715     # one "Default"
 716     #keystoneAuthRealm.defaultDomain = Default
 717
 718 Once configured the realm, the mandatory fields are the fully quallified name of
 719 the class implementing the realm *keystoneAuthRealm* and the endpoint where the
 720 Keystone Server is listening *keystoneAuthRealm.url*.
 721
 722 The optional parameter *keystoneAuthRealm.sslVerification* specifies whether the
 723 realm has to verify the SSL certificate or not. The optional parameter
 724 *keystoneAuthRealm.defaultDomain* allows to use a different default domain from
 725 the hard-coded one *"Default"*.
 726
 727 Authorization Configuration
 728 ---------------------------
 729
 730 OpenDaylight supports two authorization engines at present, both of which are
 731 roughly similar in behavior:
 732
 733 - Shiro-Based Authorization
 734
 735 - MDSAL-Based Dynamic Authorization
 736
 737 .. note::
 738
 739     The preferred mechanism for configuring AAA Authentication is the
 740     MDSAL-Based Dynamic Authorization. Read the following section.
 741
 742 Shiro-Based Static Authorization
 743 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 744
 745 OpenDaylight AAA has support for Role Based Access Control (RBAC) based
 746 on the Apache Shiro permissions system. Configuration of the authorization
 747 system is done off-line; authorization currently cannot be configured
 748 after the controller is started. The Authorization provided by this mechanism
 749 is aimed towards supporting coarse-grained security policies, the MDSAL-Based
 750 mechanism allows for a more robust configuration capabilities. `Shiro-based
 751 Authorization <http://shiro.apache.org/web.html#Web-%7B%7B%5Curls%5C%7D%7D>`_
 752 describes how to configure the Authentication feature in detail.
 753
 754 .. note::
 755
 756     The Shiro-Based Authorization that uses the *shiro.ini* URLs section to
 757     define roles requirements is **deprecated** and **discouraged** since the
 758     changes made to the file are only honored on a controller restart.
 759
 760     Shiro-Based Authorization is not **cluster-aware**, so the changes made on
 761     the *shiro.ini* file have to be replicated on every controller instance
 762     belonging to the cluster.
 763
 764     The URL patterns are matched relative to the Servlet context leaving room
 765     for ambiguity, since many endpoints may match (i.e., "/restconf/modules" and
 766     "/auth/modules" would both match a "/modules/\**" rule).
 767
 768 Enable “admin” Role Based Access to the IdMLight RESTful web service
 769 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 770
 771 Edit the “etc/shiro.ini” configuration file and add “/auth/v1/\**=
 772 authcBasic, roles[admin]” above the line “/\** = authcBasic” within the
 773 “urls” section.
 774
 775 ::
 776
 777     /auth/v1/** = authcBasic, roles[admin]
 778     /** = authcBasic
 779
 780 This will restrict the idmlight rest endpoints so that a grant for admin
 781 role must be present for the requesting user.
 782
 783 .. note::
 784
 785     The ordering of the authorization rules above is important!
 786
 787 MDSAL-Based Dynamic Authorization
 788 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 789 The MDSAL-Based Dynamic authorization uses the MDSALDynamicAuthorizationFilter
 790 engine to restrict access to particular URL endpoint patterns. Users may define
 791 a list of policies that are insertion-ordered. Order matters for that list of
 792 policies, since the first matching policy is applied. This choice was made to
 793 emulate behavior of the Shiro-Based Authorization mechanism.
 794
 795 A **policy** is a key/value pair, where the key is a **resource**
 796 (i.e., a "URL pattern") and the value is a list of **permissions** for the
 797 resource. The following describes the various elements of a policy:
 798
 799 - **Resource**: the resource is a string URL pattern as outlined by
 800   Apache Shiro. For more information, see http://shiro.apache.org/web.html.
 801
 802 - **Description**: an optional description of the URL endpoint and why it is
 803   being secured.
 804
 805 - **Permissions list**: a list of permissions for a particular policy. If more
 806   than one permission exists in the permissions list they are evaluated using
 807   logical "OR". A permission describes the prerequisites to perform HTTP
 808   operations on a particular endpoint. The following describes the various
 809   elements of a permission:
 810
 811   + **Role**: the role required to access the target URL endpoint.
 812   + **Actions list**: a leaf-list of HTTP permissions that are allowed for a
 813     Subject possessing the required role.
 814
 815 This an example on how to limit access to the modules endpoint:
 816
 817 ::
 818
 819     HTTP Operation:
 820     put URL: /restconf/config/aaa:http-authorization/policies
 821
 822     headers: Content-Type: application/json Accept: application/json
 823
 824     body:
 825       { "aaa:policies":
 826         { "aaa:policies":
 827           [ { "aaa:resource": "/restconf/modules/**",
 828             "aaa:permissions": [ { "aaa:role": "admin",
 829                                    "aaa:actions": [ "get",
 830                                                     "post",
 831                                                     "put",
 832                                                     "patch",
 833                                                     "delete"
 834                                                   ]
 835                                  }
 836                                ]
 837             }
 838           ]
 839         }
 840       }
 841
 842 The above example locks down access to the modules endpoint (and any URLS
 843 available past modules) to the "admin" role. Thus, an attempt from the OOB
 844 *admin* user will succeed with 2XX HTTP status code, while an attempt from the
 845 OOB *user* user will fail with HTTP status code 401, as the user *user* is not
 846 granted the "admin" role.
 847
 848 Accounting Configuration
 849 ------------------------
 850
 851 Accounting is handled through the standard slf4j logging mechanisms used by the
 852 rest of OpenDaylight. Thus, one can control logging verbosity through
 853 manipulating the log levels for individual packages and classes directly through
 854 the Karaf console, JMX, or etc/org.ops4j.pax.logging.cfg. In normal operations,
 855 the default levels exposed do not provide much information about AAA services;
 856 this is due to the fact that logging can severely degrade performance.
 857
 858 All AAA logging is output to the standard karaf.log file. For debugging purposes
 859 (i.e., to enable maximum verbosity), issue the following command:
 860
 861 ::
 862
 863     log:set TRACE org.opendaylight.aaa
 864
 865 Enable Successful/Unsuccessful Authentication Attempts Logging
 866 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 867
 868 By default, successful/unsuccessful authentication attempts are NOT logged. This
 869 is due to the fact that logging can severely decrease REST performance.
 870 To enable logging of successful/unsuccessful REST attempts, issue the following
 871 command in Karaf's console:
 872
 873 ::
 874
 875     log:set DEBUG org.opendaylight.aaa.shiro.filters.AuthenticationListener
 876
 877 It is possible to add custom AuthenticationListener(s) to the Shiro-based
 878 configuration, allowing different ways to listen for successful/unsuccessful
 879 authentication attempts. Custom AuthenticationListener(s) must implement
 880 the org.apache.shiro.authc.AuthenticationListener interface.
 881
 882 .. _certificate-management:
 883 Certificate Management
 884 ----------------------
 885
 886 The **Certificate Management Service** is used to manage the keystores and
 887 certificates at the OpenDaylight distribution to easily provides the TLS
 888 communication.
 889
 890 The Certificate Management Service managing two keystores:
 891
 892 1. **OpenDaylight Keystore** which holds the OpenDaylight distribution
 893    certificate self sign certificate or signed certificate from a root CA based
 894    on generated certificate request.
 895
 896 2. **Trust Keystore** which holds all the network nodes certificates that shall
 897    to communicate with the OpenDaylight distribution through TLS communication.
 898
 899 The Certificate Management Service stores the keystores (OpenDaylight & Trust)
 900 as *.jks* files under configuration/ssl/ directory. Also the keystores
 901 could be stored at the MD-SAL datastore in case OpenDaylight distribution
 902 running at cluster environment. When the keystores are stored at MD-SAL,
 903 the Certificate Management Service rely on the **Encryption-Service** to encrypt
 904 the keystore data before storing it to MD-SAL and decrypted at runtime.
 905
 906 How to use the Certificate Management Service to manage the TLS communication
 907 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 908
 909 The following are the steps to configure the TLS communication:
 910
 911 1. After starting the distribution, the *odl-aaa-cert* feature has to get
 912 installed. Use the following command at Karaf CLI to check.
 913
 914 .. code-block:: bash
 915
 916   opendaylight-user@root>feature:list -i | grep aaa-cert
 917   odl-aaa-cert | 0.5.0-SNAPSHOT | x | odl-aaa-0.5.0-SNAPSHOT | OpenDaylight :: AAA :: aaa certificate Service
 918
 919 2. The initial configuration of the Certificate Manager Service exists under
 920 the distribution directory etc/opendaylight/datastore/initial/config/aaa-cert-config.xml.
 921
 922 .. code-block:: xml
 923
 924   <aaa-cert-service-config xmlns="urn:opendaylight:yang:aaa:cert">
 925     <use-config>false</use-config>
 926     <use-mdsal>false</use-mdsal>
 927     <bundle-name>opendaylight</bundle-name>
 928     <ctlKeystore>
 929       <name>ctl.jks</name>
 930       <alias>controller</alias>
 931       <store-password/>
 932       <dname>CN=ODL, OU=Dev, O=LinuxFoundation, L=QC Montreal, C=CA</dname>
 933       <validity>365</validity>
 934       <key-alg>RSA</key-alg>
 935       <sign-alg>SHA1WithRSAEncryption</sign-alg>
 936        <keysize>1024</keysize>
 937        <cipher-suites>
 938          <suite-name />
 939        </cipher-suites>
 940     </ctlKeystore>
 941     <trustKeystore>
 942       <name>truststore.jks</name>
 943       <store-password/>
 944     </trustKeystore>
 945   </aaa-cert-service-config>
 946
 947
 948 Now as it is explained above, the Certificate Manager Service support two mode
 949 of operations; cluster mode and single mode. To use the single mode change the
 950 use-config to true and it is recommended as long as there is no need for
 951 cluster environment. To use the cluster mode change the use-config and
 952 use-mdsal configurations to true and the keystores will be stored and shard
 953 across the cluster nodes within the MD-SAL datastore.
 954
 955 The initial password become randomly generated when the *aaa-cert* feature is
 956 installed.
 957
 958 The cipher suites can be restricted by changing the **<cipher-suites>**
 959 configuration, however, the JDK has to be upgraded by installing the `Java
 960 Cryptography Extension
 961 <http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html>`_
 962 policy.
 963
 964 .. code-block:: xml
 965
 966   <cipher-suites>
 967     <suite-name>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</suite-name>
 968   </cipher-suites>
 969     <cipher-suites>
 970   <suite-name>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</suite-name>
 971     </cipher-suites>
 972   <cipher-suites>
 973     <suite-name>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</suite-name>
 974   </cipher-suites>
 975
 976 3. The new configurations will take affect after restarting the distribution.
 977
 978 4. Now to add or get certificate to the OpenDaylight and Trust keystores, the
 979 Certificate Manager Service provides the following RPCs.
 980
 981 ::
 982
 983   a) Set the node certificate that will communicate with OpeDaylight through TLS
 984   connection.
 985   POST /operations/aaa-cert-rpc:setNodeCertifcate
 986   {
 987     "input": {
 988       "node-cert": "string",
 989       "node-alias": "string"
 990     }
 991   }
 992
 993 ::
 994
 995   b) Get the node certificate based on node alias.
 996   POST /operations/aaa-cert-rpc:getNodeCertifcate
 997   {
 998     "input": {
 999       "node-alias": "string"
1000     }
1001   }
1002
1003 ::
1004
1005   c) Get the OpeDaylight keystore certificate.
1006   POST /operations/aaa-cert-rpc:getODLCertificate
1007   {
1008     output {
1009       odl-cert "string"
1010     }
1011   }
1012
1013 ::
1014
1015   d) Generate a certificate request from the OpeDaylight keystore to be signed
1016   by a CA.
1017   POST /operations/aaa-cert-rpc:getODLCertificateReq
1018   {
1019     output {
1020       odl-cert-req "string"
1021     }
1022   }
1023
1024 ::
1025
1026   e) Set the OpeDaylight certificate, the certificate should be generated
1027   based on a certificate request generated from the ODL keystore otherwise the
1028   certificated will not be added.
1029   POST /operations/aaa-cert-rpc:setODLCertificate
1030   {
1031     "input": {
1032       "odl-cert-alias": "string",
1033       "odl-cert": "string"
1034     }
1035   }
1036
1037 .. note::
1038
1039   The Certificate Manager Service RPCs are allowed only to the Role Admin Users
1040   and it could be completely disabled through the shiro.ini config file. Check
1041   the URL section at the shiro.ini.
1042
1043 Encryption Service
1044 ------------------
1045
1046 The **AAA Encryption Service** is used to encrypt the OpenDaylight's users'
1047 passwords and TLS communication certificates. This section shows how to use the
1048 AAA Encryption Service with an OpenDaylight distribution project to encrypt data.
1049
1050 The following are the steps to configure the Encryption Service:
1051
1052 1. After starting the distribution, the *aaa-encryption-service* feature has to
1053    get installed. Use the following command at Karaf CLI to check.
1054
1055    .. code-block:: bash
1056
1057       opendaylight-user@root>feature:list -i | grep aaa-encryption-service
1058       odl-aaa-encryption-service | 0.5.0-SNAPSHOT | x | odl-aaa-0.5.0-SNAPSHOT | OpenDaylight :: AAA :: Encryption Service
1059
1060 2. The initial configuration of the Encryption Service exists under the
1061    distribution directory etc/opendaylight/datastore/initial/config/aaa-encrypt-service-config.xml
1062
1063    .. code-block:: xml
1064
1065       <aaa-encrypt-service-config xmlns="config:aaa:authn:encrypt:service:config">
1066         <encrypt-key/>
1067         <encrypt-salt/>
1068         <encrypt-method>PBKDF2WithHmacSHA1</encrypt-method>
1069         <encrypt-type>AES</encrypt-type>
1070         <encrypt-iteration-count>32768</encrypt-iteration-count>
1071         <encrypt-key-length>128</encrypt-key-length>
1072         <cipher-transforms>AES/CBC/PKCS5Padding</cipher-transforms>
1073       </aaa-encrypt-service-config>
1074
1075    .. note::
1076
1077       Both the initial encryption key and encryption salt become randomly generated
1078       when the *aaa-encryption-service* feature is installed.
1079
1080 3. Finally the new configurations will take affect after restarting the
1081    distribution.
1082
1083 Using the AAA Command Line Interface (CLI)
1084 ------------------------------------------
1085 The AAA offers a CLI through the Karaf's console. This CLI allows the user to
1086 configure and use some of the functionalities provided by AAA.
1087
1088 The AAA CLI exists under the **odl-aaa-cli** feature. This feature can be
1089 installed by executing the following command.
1090
1091 ::
1092
1093   feature:install odl-aaa-cli
1094
1095 To check that the installation of the feature succeeded type "aaa" and press
1096 *tab* to see the list of available commands under the *aaa* scope.
1097
1098 ::
1099
1100   opendaylight-user@root>aaa:
1101   aaa:add-domain           aaa:add-grant            aaa:add-role             aaa:add-user
1102   aaa:change-user-pwd      aaa:export-keystores     aaa:gen-cert-req         aaa:get-cipher-suites
1103   aaa:get-domains          aaa:get-node-cert        aaa:get-odl-cert         aaa:get-roles
1104   aaa:get-tls-protocols    aaa:get-users            aaa:import-keystores     aaa:remove-domain
1105   aaa:remove-grant         aaa:remove-role          aaa:remove-user
1106
1107 Add a User
1108 ^^^^^^^^^^
1109
1110 The *add-user* command allows for adding an OpenDaylight user. The following
1111 user parameters can be specified.
1112
1113 ::
1114
1115   aaa:add-user --name <user name>
1116                --roleName <role>
1117                --userDescription <user description>
1118                --email <user email>
1119                --domainName <domain name>
1120
1121 List available Users
1122 ^^^^^^^^^^^^^^^^^^^^
1123
1124 The *get-users* command list all the available users within the Controller.
1125
1126 ::
1127
1128   aaa:get-users
1129
1130     user
1131     admin
1132
1133 Remove a User
1134 ^^^^^^^^^^^^^
1135
1136 The *remove-user* command allows for removing an OpenDaylight user. The command
1137 needs the user name as parameter.
1138
1139 ::
1140
1141   aaa:remove-user --name <user name>
1142
1143 Change the OpenDaylight user password
1144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1145
1146 The *change-user-pwd* command allows for changing the OpenDaylight user's
1147 password. It takes the user name as argument then will ask for the given user
1148 current password.
1149
1150 ::
1151
1152   aaa:change-user-pwd -user admin
1153     Enter current password:
1154     Enter new password:
1155     admin's password has been changed
1156
1157 Add a Role
1158 ^^^^^^^^^^
1159
1160 The *add-role* command allows for adding a role to the Controller.
1161
1162 ::
1163
1164   aaa:add-role --name <role name>
1165                --desc <role description>
1166                --domainName <domain name>
1167
1168 List available Roles
1169 ^^^^^^^^^^^^^^^^^^^^
1170
1171 The *get-roles* command list all the available roles within the controller.
1172
1173 ::
1174
1175   aaa:get-roles
1176
1177     user
1178     admin
1179
1180 Remove a Role
1181 ^^^^^^^^^^^^^
1182
1183 The *remove-role* command allows for removing an OpenDaylight role. The command
1184 needs the role name as parameter.  The role will be removed from those users who
1185 have it.
1186
1187 ::
1188
1189   aaa:remove-role --name <role name>
1190
1191 Add a Domain
1192 ^^^^^^^^^^^^
1193
1194 The *add-domain* command allows for adding a domain to the Controller.
1195
1196 ::
1197
1198   aaa:add-domain --name <domain name>
1199                  --desc <domain description>
1200
1201 List available Domains
1202 ^^^^^^^^^^^^^^^^^^^^^^
1203
1204 The *get-domains* command list all the available domains within the controller.
1205 The system asks for the administrator credentials to execute this command.
1206
1207 ::
1208
1209   aaa:get-domains
1210
1211     sdn
1212
1213 Remove a Domain
1214 ^^^^^^^^^^^^^^^
1215
1216 The *remove-domain* command allows for removing an OpenDaylight role. The command
1217 needs the domain name as parameter.
1218
1219 ::
1220
1221   aaa:remove-domain --name <domain name>
1222
1223 Add a Grant
1224 ^^^^^^^^^^^
1225
1226 The *add-grant* command allows for creating a grant for an existing user. The
1227 command returns a grant id for that user.
1228
1229 ::
1230
1231   aaa:add-grant --userName <user name>
1232                 --domainName <domain name>
1233                 --roleName <role name>
1234
1235 Remove a Grant
1236 ^^^^^^^^^^^^^^
1237
1238 The *remove-grant* command allows for removing an OpenDaylight grant. This command
1239 needs the user name, domain and and role as parameters.
1240
1241 ::
1242
1243   aaa:remove-grant --userName <user name>
1244                    --domainName <domain name>
1245                    --roleName <role name>
1246
1247 Generate Certificate Request
1248 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1249
1250 Generate certificate request command will generate a certificate request based
1251 on the generated OpenDaylight keystore and print it on the Karaf CLI. The system
1252 asks for the keystore password.
1253
1254 ::
1255
1256   aaa:gen-cert-req
1257
1258   -----BEGIN CERTIFICATE REQUEST-----
1259   MIIBlzCCAQACAQAwWTELMAkGA1UEBhMCQ0ExFDASBgNVBAcMC1FDIE1vbnRyZWFsMRgwFgYDVQQKDA
1260   9MaW51eEZvdW5kYXRpb24xDDAKBgNVBAsMA0RldjEMMAoGA1UEAwwDT0RMMIGfMA0GCSqGSIb3DQEB
1261   AQUAA4GNADCBiQKBgQCCmLW6j+JLYJM5yAMwscw/CHqPnp5elPa1YtQsHKEAvp1I+mLVtHKZeXeteA
1262   kyp6ORxw6KQ515fcDyQVrRJiSM15jUd27UaFq5ku0+qJeG+Qh2btx+cvNSE7/+cgUWWosKz4Aff5F5
1263   FqR62jLUTNzqCvoaTbZaOnLYVq+O2dYyZwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBADhDr4Jm7gVm/o
1264   p861/FShyw1ZZscxOEl2TprJZiTO6sn3sLptQZv8v52Z+Jm5dAgr7L46c97Xfa+0j6Y4LXNb0f88lL
1265   RG8PxGbk6Tqbjqc0WS+U1Ibc/rcPK4HEN/bcYCn+Na1gLBaFXUPg08ozG6MwqFNeS5Z0jz1W0D9/oiao
1266   -----END CERTIFICATE REQUEST-----
1267
1268 Get OpenDaylight Certificate
1269 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1270
1271 The *get-odl-certificate* command will print the OpenDaylight certificate at the
1272 Karaf CLI. The system asks for the keystore password.
1273
1274 ::
1275
1276   aaa:get-odl-cert -storepass <store_password>
1277
1278   -----BEGIN CERTIFICATE-----
1279   MIICKTCCAZKgAwIBAgIEI75RWDANBgkqhkiG9w0BAQUFADBZMQwwCgYDVQQDDANPREwxDDAKBgNVBA
1280   sMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVhbDELMAkG
1281   A1UEBhMCQ0EwHhcNMTYxMTMwMTYyNDE3WhcNMTcxMTMwMTYyNDE3WjBZMQwwCgYDVQQDDANPREwxDD
1282   AKBgNVBAsMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVh
1283   bDELMAkGA1UEBhMCQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAIKYtbqP4ktgkznIAzCxzD
1284   8Ieo+enl6U9rVi1CwcoQC+nUj6YtW0cpl5d614CTKno5HHDopDnXl9wPJBWtEmJIzXmNR3btRoWrmS
1285   7T6ol4b5CHZu3H5y81ITv/5yBRZaiwrPgB9/kXkWpHraMtRM3OoK+hpNtlo6cthWr47Z1jJnAgMBAA
1286   EwDQYJKoZIhvcNAQEFBQADgYEAL9DK/P/yEBre3Mg3bICAUAvSvZic+ydDmigWLsY4J3UzKdV2f1jI
1287   s+rQTEgtlHShBf/ed546D49cp3XEzYrcxgILhGXDziCrUK0K1TiYqPTp6FLijjdydGlPpwuMyyV5Y0
1288   iDiRclWuPz2fHbs8WQOWNs6VQ+WaREXtEsEC4qgSo=
1289   -----END CERTIFICATE-----
1290
1291 Get Cipher Suites
1292 ^^^^^^^^^^^^^^^^^
1293
1294 The *get-cipher-suites* command shows the cipher suites supported by the
1295 JVM used by the OpenDaylight controller in TLS communication. For example, here
1296 are the `Default Ciphers Suites in JDK 8 <http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites>`_.
1297
1298 ::
1299
1300   aaa:get-cipher-suites
1301
1302     TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1303     TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1304     TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1305
1306 Get TLS Protocols
1307 ^^^^^^^^^^^^^^^^^
1308
1309 The *get-tls-protocols* command shows the TLS protocols supported by the
1310 JVM used by the OpenDaylight controller. For example, the JDK 8 supports the
1311 following TLS protocols: TLSv1.2 (default), TLSv1.1, TLSv1 and SSLv3.
1312
1313 ::
1314
1315   aaa:get-tls-protocols
1316
1317     TLS_KRB5_WITH_RC4_128_SHA
1318     TLS_KRB5_WITH_RC4_128_MD5
1319     TLS_KRB5_WITH_3DES_EDE_CBC_SHA
1320     TLS_KRB5_WITH_3DES_EDE_CBC_MD5
1321     TLS_KRB5_WITH_DES_CBC_SHA
1322
1323 Get Node Certificate
1324 ^^^^^^^^^^^^^^^^^^^^
1325
1326 The *get-node-cert* command prints a certificate for a given network node alias.
1327 This command is useful to check if the network node certificate has been added
1328 properly to the truest keystore. It takes the certificate alias as arguments.
1329
1330 ::
1331
1332   aaa:get-node-cert -alias ovs1
1333   -----BEGIN CERTIFICATE-----
1334   MIICKTCCAZKgAwIBAgIEI75RWDANBgkqhkiG9w0BAQUFADBZMQwwCgYDVQQDDANPREwxDDAKBgNVBA
1335   sMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVhbDELMAkG
1336   A1UEBhMCQ0EwHhcNMTYxMTMwMTYyNDE3WhcNMTcxMTMwMTYyNDE3WjBZMQwwCgYDVQQDDANPREwxDD
1337   AKBgNVBAsMA0RldjEYMBYGA1UECgwPTGludXhGb3VuZGF0aW9uMRQwEgYDVQQHDAtRQyBNb250cmVh
1338   bDELMAkGA1UEBhMCQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAIKYtbqP4ktgkznIAzCxzD
1339   8Ieo+enl6U9rVi1CwcoQC+nUj6YtW0cpl5d614CTKno5HHDopDnXl9wPJBWtEmJIzXmNR3btRoWrmS
1340   7T6ol4b5CHZu3H5y81ITv/5yBRZaiwrPgB9/kXkWpHraMtRM3OoK+hpNtlo6cthWr47Z1jJnAgMBAA
1341   EwDQYJKoZIhvcNAQEFBQADgYEAL9DK/P/yEBre3Mg3bICAUAvSvZic+ydDmigWLsY4J3UzKdV2f1jI
1342   s+rQTEgtlHShBf/ed546D49cp3XEzYrcxgILhGXDziCrUK0K1TiYqPTp6FLijjdydGlPpwuMyyV5Y0
1343   iDiRclWuPz2fHbs8WQOWNs6VQ+WaREXtEsEC4qgSo=
1344   -----END CERTIFICATE-----
1345
1346 Export Keystores
1347 ^^^^^^^^^^^^^^^^
1348
1349 The *export-keystores* command exports the default MD-SAL Keystores to .jks
1350 files in the default directory for keystores (configuration/ssl/).
1351
1352 ::
1353
1354   aaa:export-keystores
1355
1356     Default directory for keystores is configuration/ssl/
1357
1358 Import Keystores
1359 ^^^^^^^^^^^^^^^^
1360
1361 The *import-keystores* command imports the default MD-SAL Keystores. The
1362 keystores (odl and trust) should exist under default SSL directory
1363 (configuration/ssl/).
1364
1365 .. code-block:: bash
1366
1367   aaa:import-keystores --trustKeystoreName <name of the trust keystore>
1368                        --trustKeystorePwd <password for the trust keystore>
1369                        --odlKeystoreName <name of the ODL keystore>
1370                        --odlKeystorePwd <password for the ODL keystore>
1371                        --odlKeystoreAlias <alias of the ODL keystore>
1372                        --tlsProtocols <list of TLS protocols separated by ','>
1373                        --cipherSuites <list of Cipher suites separated by ','>
1374
1375 .. warning::
1376
1377   It is strongly recommended to run the history clear command after you execute
1378   all the AAA CLI commands so Karaf logs stay clean from any adversary.
1379
1380   ::
1381
1382     history -c