emqx_authn_jwt.hocon 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. emqx_authn_jwt {
  2. acl_claim_name.desc:
  3. """JWT claim name to use for getting ACL rules."""
  4. acl_claim_name.label:
  5. """ACL claim name"""
  6. algorithm.desc:
  7. """JWT signing algorithm, Supports HMAC (configured as <code>hmac-based</code>) and RSA, ECDSA (configured as <code>public-key</code>)."""
  8. algorithm.label:
  9. """JWT Signing Algorithm"""
  10. cacertfile.desc:
  11. """Path to a file containing PEM-encoded CA certificates."""
  12. cacertfile.label:
  13. """CA Certificate File"""
  14. certfile.desc:
  15. """Path to a file containing the user certificate."""
  16. certfile.label:
  17. """Certificate File"""
  18. enable.desc:
  19. """Enable/disable SSL."""
  20. enable.label:
  21. """Enable/disable SSL"""
  22. endpoint.desc:
  23. """JWKS endpoint, it's a read-only endpoint that returns the server's public key set in the JWKS format."""
  24. endpoint.label:
  25. """JWKS Endpoint"""
  26. from.desc:
  27. """Field to take JWT from."""
  28. from.label:
  29. """From Field"""
  30. jwt_hmac.desc:
  31. """Configuration when the JWT for authentication is issued using the HMAC algorithm."""
  32. jwt_jwks.desc:
  33. """Configuration when JWTs used for authentication need to be fetched from the JWKS endpoint."""
  34. keyfile.desc:
  35. """Path to a file containing the user's private PEM-encoded key."""
  36. keyfile.label:
  37. """Key File"""
  38. jwt_public_key.desc:
  39. """Configuration when the JWT for authentication is issued using RSA or ECDSA algorithm."""
  40. public_key.desc:
  41. """The public key used to verify the JWT."""
  42. public_key.label:
  43. """Public Key"""
  44. refresh_interval.desc:
  45. """JWKS refresh interval."""
  46. refresh_interval.label:
  47. """JWKS Refresh Interval"""
  48. secret.desc:
  49. """The key to verify the JWT using HMAC algorithm."""
  50. secret.label:
  51. """Secret"""
  52. secret_base64_encoded.desc:
  53. """Whether secret is base64 encoded."""
  54. secret_base64_encoded.label:
  55. """Whether Secret is Base64 Encoded"""
  56. server_name_indication.desc:
  57. """Server Name Indication (SNI)."""
  58. server_name_indication.label:
  59. """Server Name Indication"""
  60. ssl.desc:
  61. """SSL options."""
  62. ssl.label:
  63. """SSL Options"""
  64. use_jwks.desc:
  65. """Whether to use JWKS."""
  66. use_jwks.label:
  67. """Whether to Use JWKS"""
  68. verify.desc:
  69. """Enable or disable SSL peer verification."""
  70. verify.label:
  71. """Verify"""
  72. verify_claims.desc:
  73. """A list of custom claims to validate, which is a list of name/value pairs.
  74. Values can use the following placeholders:
  75. - <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting
  76. - <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
  77. Authentication will verify that the value of claims in the JWT (taken from the Password field) matches what is required in <code>verify_claims</code>."""
  78. verify_claims.label:
  79. """Verify Claims"""
  80. }