REST API Authentication
rekuiper supports JWT RSA256 authentication for management REST APIs when enabled.
To enable authentication:
- Place your RSA public key file in the
etc/mgmtdirectory. - Sign your JWT tokens using the matching RSA private key.
- Include the token in HTTP request headers:
http
Authorization: <JWT_TOKEN>If the token validates successfully, the server processes the request. If validation fails, the server returns HTTP status code 401 Unauthorized.
JWT Header
json
{
"typ": "JWT",
"alg": "RS256"
}JWT Payload Claims
The JWT payload must use the following claim schema:
| Claim | Required | Description |
|---|---|---|
iss | Yes | Issuer. Must match the filename of the public key stored in etc/mgmt. |
aud | Yes | Audience. Must be set to eKuiper. |
exp | No | Expiration timestamp in Unix epoch seconds. |
jti | No | Unique JWT identifier. |
iat | No | Issuance timestamp in Unix epoch seconds. |
nbf | No | Not-before timestamp in Unix epoch seconds. |
sub | No | Subject identifier. |
Example payload:
json
{
"iss": "sample_key.pub",
"aud": "eKuiper"
}Ensure that the public key file sample_key.pub exists in the etc/mgmt directory.
JWT Signature
Sign the token using your RSA private key. rekuiper verifies the signature against the matching public key located in etc/mgmt.
Coexistence with Console Password and Fleet Token
When basic.authentication: true is enabled alongside uiPassword or fleetToken:
- RS256 JWT Tokens: Accepted in the
Authorizationheader (either raw<JWT_TOKEN>orBearer <JWT_TOKEN>). - Web Console Password (
uiPassword): Requests carryingAuthorization: Bearer <uiPassword>are verified using constant-time byte comparison and permitted for Web Console sessions. - Fleet Control Plane Token (
fleetToken): Requests to/fleet/*or/api/v1/fleet/*carryingAuthorization: Bearer <fleetToken>orX-Fleet-Token: <fleetToken>are verified in constant time.