Kafka SSL credentials fields

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Kafka SSL Credentials Fields

    This section details the configuration of Kafka SSL credentials required for secure communication with Apache Kafka. Understanding these fields is crucial for ServiceNow customers to ensure proper integration and data security within their IT Operations Management processes.

    Show full answer Show less

    Key Features

    • SSL Keystore: Contains the server's keystore file, encoded as a Base64 string. Default type is Java KeyStore (JKS).
    • SSL Truststore: Holds the truststore file content in Base64 format, also defaulting to Java KeyStore (JKS).
    • Passwords: Both keystore and truststore passwords correspond to specific properties in Apache Kafka for authentication.
    • SSL Provider: Specifies the security provider used for SSL connections.
    • Additional Kafka Properties: Allows for the inclusion of extra semicolon-separated Kafka consumer properties for enhanced configuration.
    • User Credentials: For SASL security protocols, a username and password are required for authentication, stored securely in encrypted form.

    Key Outcomes

    By correctly filling out the Kafka SSL credentials fields, customers will enable secure connections to their Kafka servers, ensuring data integrity and confidentiality. This setup is essential for effective monitoring and logging within ITOM Health, facilitating robust health log analytics and overall system reliability.

    Description of the fields on the Kafka SSL credentials form.

    Table 1. SSL security protocol
    FIeld Description
    SSL keystore The content of an actual server.keystore.jks file, encoded as a Base64 string.
    SSL keystore type Format of the SSL keystore file. Default: Java KeyStore (JKS).
    SSL keystore password Password to the keystore, identical to the value of the ssl.keystore.password property in Apache Kafka.
    SSL key password Password, identical to the ssl.key.password property value in Apache Kafka.
    SSL truststore The content of an actual client.truststore.jks file, encoded as a Base64 string.
    SSL truststore type Format of the truststore file. Default: Java KeyStore (JKS).
    SSL truststore password Password to the truststore, identical to the value of the ssl.truststore.password property in Apache Kafka.
    SSL provider Name of the security provider used for SSL connections.
    Disable hostname verification Option to disable verification of the hostname.
    Additional Kafka consumer properties Semicolon-separated string of additional Kafka consumer properties. For example: ssl.protocol=TLSv1.2;ssl.enabled.protocols=TLSv1.2,TLSv1.1
    Table 2. SASL_SSL security protocol
    FIeld Description
    SSL truststore The content of an actual client.truststore.jks file, encoded as a Base64 string.
    SSL truststore type Format of the SSL truststore file. Default: Java KeyStore (JKS).
    SSL truststore password Password to the truststore, identical to the value of the ssl.truststore.password property in Apache Kafka.
    SSL provider Name of the security provider used for SSL connections.
    Disable hostname verification Option to disable verification of the hostname.
    User name The user name, if any, associated with this credential.
    Note:
    The specified user name is used for SASL authentication using JAAS. The following JAAS configuration is passed to the Kafka Server: org.apache.kafka.common.security.plain.PlainLoginModule required username=<user_name> password=<password>
    Password The password associated with this credential.
    Note:
    • The specified password is used for SASL authentication using JAAS. The following JAAS configuration is passed to the Kafka Server: org.apache.kafka.common.security.plain.PlainLoginModule required username=<user_name> password=<password>
    • The password you specify is invisible. It is stored in the database in encrypted form.
    Additional Kafka consumer properties Semicolon-separated string of additional Kafka consumer properties. For example: ssl.protocol=TLSv1.2;ssl.enabled.protocols=TLSv1.2,TLSv1.1
    Table 3. SASL_PLAINTEXT security protocol
    User name The user name, if any, associated with this credential.
    Note:
    The specified user name is used for SASL authentication using JAAS. The following JAAS configuration is passed to the Kafka Server: org.apache.kafka.common.security.plain.PlainLoginModule required username=<user_name> password=<password>
    Password The password associated with this credential.
    Note:
    • The specified password is used for SASL authentication using JAAS. The following JAAS configuration is passed to the Kafka Server: org.apache.kafka.common.security.plain.PlainLoginModule required username=<user_name> password=<password>
    • The password you specify is invisible. It is stored in the database in encrypted form.
    Additional Kafka consumer properties Semicolon-separated string of additional Kafka consumer properties. For example: ssl.protocol=TLSv1.2;ssl.enabled.protocols=TLSv1.2,TLSv1.1