docs/sections/installation/AAF-Integration-Guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   4
   5 AAF Integration Guide
   6 ============================
   7 .. code:: bash
   8
   9    cadi.properties Template
  10   # This is a normal Java Properties File
  11   # Comments are with Pound Signs at beginning of lines,
  12   # and multi-line expression of properties can be obtained by backslash at end of line
  13   #hostname=
  14
  15   cadi_loglevel=WARN
  16   cadi_keyfile=conf/keyfile
  17
  18
  19   # Configure AAF
  20   aaf_url=http://172.18.0.2:8101
  21   #if you are running aaf service from a docker image you have to use aaf service IP and port number
  22   aaf_id=<yourAPPID>@onap.org
  23   aaf_password=enc:<encrypt>
  24
  25   aaf_dme_timeout=5000
  26   # Note, User Expires for not Unit Test should be something like 900000 (15 mins) default is 10 mins
  27   # 15 seconds is so that Unit Tests don't delay compiles, etc
  28   aaf_user_expires=15000
  29   # High count... Rough top number of objects held in Cache per cycle.  If high is reached, more are
  30   # recycled next time.  Depending on Memory usage, 2000 is probably decent.  1000 is default
  31   aaf_high_count=100
  32
  33
  34 How to create CADI Keyfile & Encrypt Password
  35 ---------------------------------------------
  36
  37 Password Encryption
  38 -------------------
  39 CADI provides a method to encrypt data so that Passwords and other sensitive data can be stored safely.
  40
  41 Keygen (Generate local Symmetrical Key)
  42 A Keyfile is created by Cadi Utility.
  43
  44 .. code:: bash
  45
  46   java -jar cadi-core-<version>.jar keygen <keyfile>
  47 Given this key file unlocks any passwords created, it should be stored in your configuration directory and protected with appropriate access permissions. For instance, if your container is Tomcat, and runs with a "tomcat" id, then you should:
  48
  49 .. code:: bash
  50
  51   java -jar cadi-core-<version>.jar keygen keyfile
  52   chmod 400 keyfile
  53   chown tomcat:tomcat keyfile
  54
  55 Digest - Encrypt a Password
  56 ---------------------------
  57 The password is obtained by using the Cadi digest Utility (contained in the cadi-core-<version>.jar).
  58
  59 .. code:: bash
  60
  61   java -jar cadi-core-<version>.jar digest <your_password> <keyfile>
  62    •  "<keyfile>" is created by Cadi Utility, #keygen
  63    •  Understand that if you change the keyfile, then you need to rerun "digest" on passwords used in the users/groups definitions.
  64    •  Note: You cannot mix versions of cadi; the version used to digest your password must be the same version used at runtime.
  65
  66 CADI PROPERTIES
  67    CADI properties, typically named "cadi.properties", must have passwords encrypted.
  68       1.        Take the results of the "Digest" command and prepend "enc:"
  69       2.        Use this as the value of your property
  70
  71 Example:   aaf_password=enc:fMKMBfKHlRWL68cxD5XSIWNKRNYi5dih2LEHRFMIsut
  72