docs/sections/services/ves-http/tls-authentication.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. raw:: html
   4
   5     <style> .red {color:red} </style>
   6     <style> .green {color:green} </style>
   7 .. role:: red
   8 .. role:: green
   9
  10 Authentication Types
  11 ====================
  12
  13 VES supports mutual TLS authentication via X.509 certificates. If VES is deployed via docker image then VES configuration can be modified by editing */opt/app/VESCollector/etc/collector.properties* which is present on the docker container. VES detects changes made to the mentioned file automatically and restarts the application.
  14
  15 The authentication can be enabled by *collector.service.secure.clientauth* property. When *collector.service.secure.clientauth=1* VES uses additional properties:
  16
  17     * *collector.truststore.file.location* - a path to jks trust store containing certificates of clients or certificate authorities
  18     * *collector.truststore.passwordfile* - a path to file containing password for the trust store
  19
  20 Of course, mutual TLS authentication requires also server certificates, so following properties have to be set to valid values:
  21
  22     * *collector.keystore.file.location* - a path to jks key store containing certificates which can be used for TLS handshake
  23     * *collector.keystore.passwordfile* - a path to file containing a password for the key store
  24
  25 Property *auth.method* is used to manage security mode, possible configuration: noAuth, certBasicAuth
  26
  27     * *auth.method=noAuth* default option - no security (http)
  28
  29     * *auth.method=certBasicAuth* is used to enable mutual TLS authentication or/and basic HTTPs authentication
  30
  31      * client without cert and without basic auth = :red:`Authentication failure`
  32      * client without cert and wrong basic auth = :red:`Authentication failure`
  33      * client without cert and correct basic auth = :green:`Authentication successful`
  34      * client with cert and without/wrong basic auth = :green:`Authentication successful`
  35      * client with cert and correct basic auth = :green:`Authentication successful`
  36
  37 When application is in certBasicAuth mode then certificates are also validated by regexp in /etc/certSubjectMatcher.properties,
  38 only SubjectDn field in certificate description are checked. Default regexp value is .* means that we approve all SubjectDN values.