AuditorConfig (auditor 3.8.0 API)

java.lang.Object
- com.scalar.dl.auditor.config.AuditorConfig

All Implemented Interfaces:: com.scalar.dl.ledger.config.ServerConfig, com.scalar.dl.ledger.config.ServersHmacAuthenticatable

@Immutable
public class AuditorConfig
extends java.lang.Object
implements com.scalar.dl.ledger.config.ServerConfig, com.scalar.dl.ledger.config.ServersHmacAuthenticatable

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AUTHENTICATION_HMAC_CIPHER_KEY` `scalar.dl.auditor.authentication.hmac.cipher_key` (Optional) A cipher key used to encrypt and decrypt the HMAC secret keys of client entities.
`static java.lang.String`	`AUTHENTICATION_METHOD` `scalar.dl.auditor.authentication.method` (Optional) The authentication method for a client and Auditor servers.
`static java.lang.String`	`AUTHORIZATION_CREDENTIAL` `scalar.dl.auditor.authorization.credential` (Optional) An authorization credential.
`static java.lang.String`	`CERT_HOLDER_ID` Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
`static java.lang.String`	`CERT_VERSION` Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
`static java.lang.String`	`LEDGER_CERT_HOLDER_ID` Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
`static java.lang.String`	`LEDGER_CERT_VERSION` Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
`static java.lang.String`	`LEDGER_HOST` `scalar.dl.auditor.ledger.host` (Optional) A hostname or an IP address of the server ("localhost" by default).
`static java.lang.String`	`LEDGER_PORT` `scalar.dl.auditor.ledger.port` (Optional) A port number of the server (50051 by default).
`static java.lang.String`	`LEDGER_PRIVILEGED_PORT` `scalar.dl.auditor.ledger.privileged_port` (Optional) A port number of the server for privileged services (50052 by default).
`static java.lang.String`	`NAME` `scalar.dl.auditor.name` (Optional) Name of auditor ("Scalar Auditor" by default).
`static java.lang.String`	`NAMESPACE` `scalar.dl.auditor.namespace` (Optional) Namespace of auditor tables ("auditor" by default).
`static java.lang.String`	`PRIVATE_KEY_PATH` `scalar.dl.auditor.private_key_path` (Optional) The path of a private key file in PEM format.
`static java.lang.String`	`PRIVATE_KEY_PEM` `scalar.dl.auditor.private_key_pem` (Optional) PEM-encoded private key data.
`static java.lang.String`	`SERVER_ADMIN_PORT` `scalar.dl.auditor.server.admin_port` (Optional) Server admin port (40053 by default).
`static java.lang.String`	`SERVER_PORT` `scalar.dl.auditor.server.port` (Optional) Server port (40051 by default).
`static java.lang.String`	`SERVER_PRIVILEGED_PORT` `scalar.dl.auditor.server.privileged_port` (Optional) Server privileged port (40052 by default).
`static java.lang.String`	`SERVER_PROMETHEUS_EXPORTER_PORT` `scalar.dl.auditor.server.prometheus_exporter_port` (Optional) Prometheus exporter port (8080 by default).
`static java.lang.String`	`SERVER_TLS_CERT_CHAIN_PATH` `scalar.dl.auditor.server.tls.cert_chain_path` (Optional) Certificate chain file used for TLS communication.
`static java.lang.String`	`SERVER_TLS_ENABLED` `scalar.dl.auditor.server.tls.enabled` (Optional) TLS between clients and servers (false by default).
`static java.lang.String`	`SERVER_TLS_PRIVATE_KEY_PATH` `scalar.dl.auditor.server.tls.private_key_path` (Optional) Private key file used for TLS communication.
`static java.lang.String`	`SERVERS_AUTHENTICATION_HMAC_SECRET_KEY` `scalar.dl.auditor.servers.authentication.hmac.secret_key`(Optional) A secret key of HMAC for the authentication of messages between (Ledger and Auditor) servers.
`static java.lang.String`	`TLS_CA_ROOT_CERT_PATH` `scalar.dl.auditor.tls.ca_root_cert_path` (Optional) A custom CA root certificate (file path) for TLS communication.
`static java.lang.String`	`TLS_CA_ROOT_CERT_PEM` `scalar.dl.auditor.tls.ca_root_cert_pem` (Optional) A custom CA root certificate (PEM data) for TLS communication.
`static java.lang.String`	`TLS_ENABLED` `scalar.dl.auditor.tls.enabled` (Optional) A flag to enable TLS communication (false by default).

Constructor Summary

Constructors
Constructor and Description

AuditorConfig(java.io.File propertiesFile)

AuditorConfig(java.io.InputStream stream)

AuditorConfig(java.util.Properties properties)

Constructors
Constructor and Description
`AuditorConfig(java.io.File propertiesFile)`
`AuditorConfig(java.io.InputStream stream)`
`AuditorConfig(java.util.Properties properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAdminPort()`
`com.scalar.dl.ledger.config.AuthenticationMethod`	`getAuthenticationMethod()`
`com.scalar.db.config.DatabaseConfig`	`getDatabaseConfig()`
`com.scalar.dl.client.config.DigitalSignatureIdentityConfig`	`getDigitalSignatureIdentityConfig()`
`java.lang.String`	`getHmacCipherKey()`
`java.lang.String`	`getLedgerCertHolderId()`
`int`	`getLedgerCertVersion()`
`com.scalar.dl.ledger.config.TargetConfig`	`getLedgerTargetConfig()`
`java.lang.String`	`getName()`
`java.lang.String`	`getNamespace()`
`int`	`getPort()`
`int`	`getPrivilegedPort()`
`java.lang.String`	`getProductName()`
`int`	`getPrometheusExporterPort()`
`java.lang.String`	`getServersAuthenticationHmacSecretKey()`
`java.lang.String`	`getServerTlsCertChainPath()`
`java.lang.String`	`getServerTlsPrivateKeyPath()`
`java.lang.String`	`getServiceName()`
`boolean`	`isServerTlsEnabled()`
`protected void`	`load()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    scalar.dl.auditor.name (Optional)
    Name of auditor ("Scalar Auditor" by default). It is used to identify an auditor.
    
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
public static final java.lang.String NAMESPACE
```
    scalar.dl.auditor.namespace (Optional)
    Namespace of auditor tables ("auditor" by default).
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_METHOD
```
public static final java.lang.String AUTHENTICATION_METHOD
```
    scalar.dl.auditor.authentication.method (Optional)
    The authentication method for a client and Auditor servers. ("digital-signature" by default) This has to be consistent with the client configuration.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_HMAC_CIPHER_KEY
```
public static final java.lang.String AUTHENTICATION_HMAC_CIPHER_KEY
```
    scalar.dl.auditor.authentication.hmac.cipher_key (Optional)
    A cipher key used to encrypt and decrypt the HMAC secret keys of client entities. This variable is used only when scalar.dl.auditor.authentication.method is "hmac". Please set an unpredictable and long enough value.
    
    See Also:
    
    Constant Field Values
  - SERVER_PORT
```
public static final java.lang.String SERVER_PORT
```
    scalar.dl.auditor.server.port (Optional)
    Server port (40051 by default).
    
    See Also:
    
    Constant Field Values
  - SERVER_PRIVILEGED_PORT
```
public static final java.lang.String SERVER_PRIVILEGED_PORT
```
    scalar.dl.auditor.server.privileged_port (Optional)
    Server privileged port (40052 by default).
    
    See Also:
    
    Constant Field Values
  - SERVER_ADMIN_PORT
```
public static final java.lang.String SERVER_ADMIN_PORT
```
    scalar.dl.auditor.server.admin_port (Optional)
    Server admin port (40053 by default).
    
    See Also:
    
    Constant Field Values
  - SERVER_PROMETHEUS_EXPORTER_PORT
```
public static final java.lang.String SERVER_PROMETHEUS_EXPORTER_PORT
```
    scalar.dl.auditor.server.prometheus_exporter_port (Optional)
    Prometheus exporter port (8080 by default). Prometheus exporter will not be started if a negative number is given.
    
    See Also:
    
    Constant Field Values
  - SERVER_TLS_ENABLED
```
public static final java.lang.String SERVER_TLS_ENABLED
```
    scalar.dl.auditor.server.tls.enabled (Optional)
    TLS between clients and servers (false by default).
    
    See Also:
    
    Constant Field Values
  - SERVER_TLS_CERT_CHAIN_PATH
```
public static final java.lang.String SERVER_TLS_CERT_CHAIN_PATH
```
    scalar.dl.auditor.server.tls.cert_chain_path (Optional)
    Certificate chain file used for TLS communication.
    
    See Also:
    
    Constant Field Values
  - SERVER_TLS_PRIVATE_KEY_PATH
```
public static final java.lang.String SERVER_TLS_PRIVATE_KEY_PATH
```
    scalar.dl.auditor.server.tls.private_key_path (Optional)
    Private key file used for TLS communication.
    
    See Also:
    
    Constant Field Values
  - LEDGER_HOST
```
public static final java.lang.String LEDGER_HOST
```
    scalar.dl.auditor.ledger.host (Optional)
    A hostname or an IP address of the server ("localhost" by default). It assumes that there is a single endpoint that is given by DNS or a load balancer.
    
    See Also:
    
    Constant Field Values
  - LEDGER_PORT
```
public static final java.lang.String LEDGER_PORT
```
    scalar.dl.auditor.ledger.port (Optional)
    A port number of the server (50051 by default).
    
    See Also:
    
    Constant Field Values
  - LEDGER_PRIVILEGED_PORT
```
public static final java.lang.String LEDGER_PRIVILEGED_PORT
```
    scalar.dl.auditor.ledger.privileged_port (Optional)
    A port number of the server for privileged services (50052 by default).
    
    See Also:
    
    Constant Field Values
  - SERVERS_AUTHENTICATION_HMAC_SECRET_KEY
```
public static final java.lang.String SERVERS_AUTHENTICATION_HMAC_SECRET_KEY
```
    scalar.dl.auditor.servers.authentication.hmac.secret_key(Optional)
    A secret key of HMAC for the authentication of messages between (Ledger and Auditor) servers. The same key has to be set in the corresponding Ledger as well. If this is not set, Auditor uses digital signature authentication using scalar.dl.auditor.private_key_pem/path for signing and scalar.dl.auditor.ledger.cert_holder_id and its corresponding certificate (stored in the database) for verification
    
    See Also:
    
    Constant Field Values
  - LEDGER_CERT_HOLDER_ID
```
@Deprecated
public static final java.lang.String LEDGER_CERT_HOLDER_ID
```
    Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
    
    scalar.dl.auditor.ledger.cert_holder_id (Optional)
    The holder ID of the certificate of Ledger ("ledger" by default).
    
    See Also:
    
    Constant Field Values
  - LEDGER_CERT_VERSION
```
@Deprecated
public static final java.lang.String LEDGER_CERT_VERSION
```
    Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
    
    scalar.dl.auditor.ledger.cert_version (Optional)
    The version of the certificate (1 by default). Use another bigger integer if you need to change your private key.
    
    See Also:
    
    Constant Field Values
  - CERT_HOLDER_ID
```
@Deprecated
public static final java.lang.String CERT_HOLDER_ID
```
    Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
    
    scalar.dl.auditor.cert_holder_id (Optional)
    The holder ID of a certificate ("auditor" by default).
    
    See Also:
    
    Constant Field Values
  - CERT_VERSION
```
@Deprecated
public static final java.lang.String CERT_VERSION
```
    Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
    
    scalar.dl.auditor.cert_version (Optional)
    The version of the certificate (1 by default). Use another bigger integer if you need to change your private key.
    
    See Also:
    
    Constant Field Values
  - PRIVATE_KEY_PATH
```
public static final java.lang.String PRIVATE_KEY_PATH
```
    scalar.dl.auditor.private_key_path (Optional)
    The path of a private key file in PEM format. Either this or scalar.dl.auditor.proof.private_key_pem is used for signing proofs with digital signatures. The signatures are also used for Ledger to authenticate the corresponding proofs from Auditor if scalar.dl.auditor.servers.authentication.hmac.secret_key is empty.
    
    See Also:
    
    Constant Field Values
  - PRIVATE_KEY_PEM
```
public static final java.lang.String PRIVATE_KEY_PEM
```
    scalar.dl.auditor.private_key_pem (Optional)
    PEM-encoded private key data. Either this or scalar.dl.auditor.proof.private_key_path is used for signing proofs with digital signatures. The signatures are also used for Ledger to authenticate the corresponding proofs from Auditor if scalar.dl.auditor.servers.authentication.hmac.secret_key is empty.
    
    See Also:
    
    Constant Field Values
  - TLS_ENABLED
```
public static final java.lang.String TLS_ENABLED
```
    scalar.dl.auditor.tls.enabled (Optional)
    A flag to enable TLS communication (false by default).
    
    See Also:
    
    Constant Field Values
  - TLS_CA_ROOT_CERT_PATH
```
public static final java.lang.String TLS_CA_ROOT_CERT_PATH
```
    scalar.dl.auditor.tls.ca_root_cert_path (Optional)
    A custom CA root certificate (file path) for TLS communication.
    
    See Also:
    
    Constant Field Values
  - TLS_CA_ROOT_CERT_PEM
```
public static final java.lang.String TLS_CA_ROOT_CERT_PEM
```
    scalar.dl.auditor.tls.ca_root_cert_pem (Optional)
    A custom CA root certificate (PEM data) for TLS communication.
    
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_CREDENTIAL
```
public static final java.lang.String AUTHORIZATION_CREDENTIAL
```
    scalar.dl.auditor.authorization.credential (Optional)
    An authorization credential. (e.g. authorization: Bearer token) If this is given, clients will add "authorization: [credential]" http/2 header.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AuditorConfig
```
public AuditorConfig(java.io.File propertiesFile)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - AuditorConfig
```
public AuditorConfig(java.io.InputStream stream)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - AuditorConfig
```
public AuditorConfig(java.util.Properties properties)
```
- Method Detail
  - getDatabaseConfig
```
public com.scalar.db.config.DatabaseConfig getDatabaseConfig()
```
  - getProductName
```
public java.lang.String getProductName()
```
  - getServiceName
```
public java.lang.String getServiceName()
```
    Specified by:
    
    getServiceName in interface com.scalar.dl.ledger.config.ServerConfig
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface com.scalar.dl.ledger.config.ServerConfig
  - getNamespace
```
public java.lang.String getNamespace()
```
  - getAuthenticationMethod
```
public com.scalar.dl.ledger.config.AuthenticationMethod getAuthenticationMethod()
```
  - getHmacCipherKey
```
@Nullable
public java.lang.String getHmacCipherKey()
```
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface com.scalar.dl.ledger.config.ServerConfig
  - getPrivilegedPort
```
public int getPrivilegedPort()
```
    Specified by:
    
    getPrivilegedPort in interface com.scalar.dl.ledger.config.ServerConfig
  - getAdminPort
```
public int getAdminPort()
```
    Specified by:
    
    getAdminPort in interface com.scalar.dl.ledger.config.ServerConfig
  - getPrometheusExporterPort
```
public int getPrometheusExporterPort()
```
    Specified by:
    
    getPrometheusExporterPort in interface com.scalar.dl.ledger.config.ServerConfig
  - isServerTlsEnabled
```
public boolean isServerTlsEnabled()
```
    Specified by:
    
    isServerTlsEnabled in interface com.scalar.dl.ledger.config.ServerConfig
  - getServerTlsCertChainPath
```
public java.lang.String getServerTlsCertChainPath()
```
    Specified by:
    
    getServerTlsCertChainPath in interface com.scalar.dl.ledger.config.ServerConfig
  - getServerTlsPrivateKeyPath
```
public java.lang.String getServerTlsPrivateKeyPath()
```
    Specified by:
    
    getServerTlsPrivateKeyPath in interface com.scalar.dl.ledger.config.ServerConfig
  - getDigitalSignatureIdentityConfig
```
@Nullable
public com.scalar.dl.client.config.DigitalSignatureIdentityConfig getDigitalSignatureIdentityConfig()
```
  - getLedgerTargetConfig
```
@Nonnull
public com.scalar.dl.ledger.config.TargetConfig getLedgerTargetConfig()
```
  - getLedgerCertHolderId
```
public java.lang.String getLedgerCertHolderId()
```
  - getLedgerCertVersion
```
public int getLedgerCertVersion()
```
  - getServersAuthenticationHmacSecretKey
```
@Nullable
public java.lang.String getServersAuthenticationHmacSecretKey()
```
    Specified by:
    
    getServersAuthenticationHmacSecretKey in interface com.scalar.dl.ledger.config.ServersHmacAuthenticatable
  - load
```
protected void load()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AuditorConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

NAMESPACE

AUTHENTICATION_METHOD

AUTHENTICATION_HMAC_CIPHER_KEY

SERVER_PORT

SERVER_PRIVILEGED_PORT

SERVER_ADMIN_PORT

SERVER_PROMETHEUS_EXPORTER_PORT

SERVER_TLS_ENABLED

SERVER_TLS_CERT_CHAIN_PATH

SERVER_TLS_PRIVATE_KEY_PATH

LEDGER_HOST

LEDGER_PORT

LEDGER_PRIVILEGED_PORT

SERVERS_AUTHENTICATION_HMAC_SECRET_KEY

LEDGER_CERT_HOLDER_ID

LEDGER_CERT_VERSION

CERT_HOLDER_ID

CERT_VERSION

PRIVATE_KEY_PATH

PRIVATE_KEY_PEM

TLS_ENABLED

TLS_CA_ROOT_CERT_PATH

TLS_CA_ROOT_CERT_PEM

AUTHORIZATION_CREDENTIAL

Constructor Detail

AuditorConfig

AuditorConfig

AuditorConfig

Method Detail

getDatabaseConfig

getProductName

getServiceName

getName

getNamespace

getAuthenticationMethod

getHmacCipherKey

getPort

getPrivilegedPort

getAdminPort

getPrometheusExporterPort

isServerTlsEnabled

getServerTlsCertChainPath

getServerTlsPrivateKeyPath

getDigitalSignatureIdentityConfig

getLedgerTargetConfig

getLedgerCertHolderId

getLedgerCertVersion

getServersAuthenticationHmacSecretKey

load

toString