adapters/etsi-sol003-adapter/etsi-sol003-adapter-application/Readme.txt

   1 The following describes how to configure authentication for the VNFM adapter.\r
   2 \r
   3 TLS should always be configured to ensure secure communication between the VNFM-adapter <-> BPMN infra and VNFM-adapter <-> VNFM\r
   4 If two-way TLS is configured then there is no need for any further authentication (i.e. no need for token or basic auth).\r
   5 If two-way TLS is NOT configured then authentication is REQUIRED. Oauth token based authentication must be used for requests, while for notifications either oauth tokens or basic auth can be used.\r
   6 \r
   7 \r
   8 ==========================================\r
   9 To confgure TLS\r
  10 ==========================================\r
  11 \r
  12 ---------------\r
  13 VNFM Adapter\r
  14 ---------------\r
  15 The following parameters can be set to configure the certificate for the VNFM adapter\r
  16 server:\r
  17   ssl:\r
  18     key-alias: so@so.onap.org\r
  19     key--store-password: 'ywsqCy:EEo#j}HJHM7z^Rk[L'\r
  20     key-store: classpath:so-vnfm-adapter.p12\r
  21     key-store-type: PKCS12\r
  22 The values shown above relate to the certificate included in the VNFM adapter jar which has been generated from AAF. If a different certificate is to be used then these values should be changed accordingly.\r
  23 \r
  24 The following paramters can be set to configure the trust store for the VNFM adapter:\r
  25 http:\r
  26   client:\r
  27     ssl:\r
  28       trust-store: classpath:org.onap.so.trust.jks\r
  29       trust-store-password: ',sx#.C*W)]wVgJC6ccFHI#:H'\r
  30 The values shown above relate to the trust store included in the VNFM adapter jar which has been generated from AAI. If a different trust store is to be used then these values should be changed accordingly.\r
  31 \r
  32 Ensure the value for the below parameter uses https instead of http\r
  33 vnfmadapter:\r
  34   endpoint: http://so-vnfm-adapter.onap:9092\r
  35   \r
  36 ---------------\r
  37 bpmn-infra\r
  38 ---------------\r
  39 For bpmn-infra, ensure the value for the below parameter uses https instead of http\r
  40 so:\r
  41   vnfm:\r
  42     adapter:\r
  43       url: https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1/\r
  44 \r
  45 \r
  46 ==========================================\r
  47 To use two way TLS\r
  48 ==========================================\r
  49 \r
  50 Ensure the value for username and password are empty in the AAI entry for the VNFM (The VNFM adapter will use oauth instead of two way TLS if the username/password is set).\r
  51 Ensure TLS has been configuered as detailed above.\r
  52 \r
  53 ---------------\r
  54 VNFM adapter\r
  55 ---------------\r
  56 Set the following parameter for the VNFM adapter:\r
  57 server:\r
  58   ssl:\r
  59     client-auth: need\r
  60         \r
  61 ---------------\r
  62 bpmn-infra:\r
  63 ---------------\r
  64 Set the following paramters for bpmn-infra:\r
  65 rest:\r
  66   http:\r
  67     client:\r
  68       configuration:\r
  69         ssl:\r
  70           keyStore: classpath:org.onap.so.p12\r
  71           keyStorePassword: 'RLe5ExMWW;Kd6GTSt0WQz;.Y'\r
  72           trustStore: classpath:org.onap.so.trust.jks\r
  73           trustStorePassword: '6V%8oSU$,%WbYp3IUe;^mWt4'\r
  74 Ensure the value for the below parameter uses https instead of http\r
  75 so:\r
  76   vnfm:\r
  77     adapter:\r
  78       url: https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1/\r
  79           \r
  80 ---------------   \r
  81 VNFM simulator:\r
  82 ---------------\r
  83 Set the following parameters for the VNFM simulator (if used):\r
  84 server:\r
  85   ssl:\r
  86     client-auth: need\r
  87   request:\r
  88     grant:\r
  89       auth: twowaytls\r
  90 \r
  91 ==========================================\r
  92 To use oauth token base authentication\r
  93 ==========================================\r
  94 \r
  95 ---------------   \r
  96 VNFM adapter:\r
  97 ---------------\r
  98 Ensure the value for username and password set set in the AAI entry for the VNFM. The VNFM adapter will use this username/password as the client credentials in the request for a token for the VNFM. The token endpoint\r
  99 for the VNFM will by default will be derived from the service url for the VNFM in AAI as follows: <base of service url>/oauth/token, e.g. if the service url is https://so-vnfm-simulator.onap/vnflcm/v1 then the token url will\r
 100 be taken to be https://so-vnfm-simulator.onap/oauth/token. This can be overriden using the following parameter for the VNFM adapter:\r
 101 vnfmadapter:\r
 102   temp:\r
 103     vnfm:\r
 104           oauth:\r
 105             endpoint:\r
 106                 \r
 107 The VNFM adapter exposes a token point at url: https://<hostname>:<port>/oauth/token e.g. https://so-vnfm-adapter.onap:9092/oauth/token. The VNFM can request a token from this endpoint for use in grant requests and notifications\r
 108 to the VNFM adapter. The username/password to be used in the token request are passed to the VNFM in a subscription request. The username/password sent by the VNFM adpater in the subscription request can be configuered using the \r
 109 following parameter:\r
 110 vnfmadapter:\r
 111   auth: <encoded value>\r
 112 where <encoded value> is '<username>:<password>' encoded using org.onap.so.utils.CryptoUtils with the key set by the paramter:\r
 113 mso:\r
 114   key: <key>\r
 115 The default username:password is vnfm-adapter:123456 when vnfm-adapter.auth is not set.\r
 116                   \r
 117 ---------------   \r
 118 VNFM simulator:\r
 119 ---------------\r
 120 Set the following parameters for the simulator:\r
 121 spring:\r
 122   profiles:\r
 123     active: oauth-authentication\r
 124 server:\r
 125   request:\r
 126     grant:\r
 127       auth: oauth\r
 128                 \r
 129 ==========================================\r
 130 To use basic auth for notifications\r
 131 ==========================================              \r
 132 The same username/password is used as for oauth token requests as describe above and passed to the VNFM in the subscription request.