PUT /api/lunasa/ntls

PUT /api/lunasa/ntls

Sets both the receiveTimeoutTimer and the ipCheckEnabled settings for the NTLS

Parameters

receiveTimeoutTimer

The configured NTLS timeout period for a connection setup

Use: Required

JSON Schema:

   Object
   type: integer

ipCheckEnabled

Indicates whether NTLS client source IP validation is enabled

Use: Required

JSON Schema:

   Object
   type: boolean
         false = disable NTLS client source IP validation
         true = enable NTLS client source IP validation

The following table shows defined values for receiveTimeoutTimer.

Parameter	Range	Default Value
receiveTimeoutTimer	1 - 300	20

cipherList

Cipher list is the cipher suite that NTLS service is to accept for applications requesting connection to the NTLS Server.

Supported NTLS Ciphers to support both TLS1.2 and TLS1.3

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:DHE-RSA-AES256-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA256:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 1024
   pattern: ^([a-zA-Z0-9_-]+)(:[a-zA-Z0-9_-]+)*$

groupList

Group list is the groups that NTLS service is to accept for applications requesting connection to the NTLS Server.

Supported NTLS Groups

secp256r1:P-256:secp384r1:P-384:secp521r1:P-521:x25519:x448:brainpoolP256r1tls13:brainpoolP384r1tls13:brainpoolP512r1tls13:ffdhe2048:ffdhe3072:ffdhe4096:ffdhe6144:ffdhe8192:MLKEM512:MLKEM768:MLKEM1024:SecP256r1MLKEM768:X25519MLKEM768:SecP384r1MLKEM1024

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 1024
   pattern: ^([a-zA-Z0-9_-]+)(:[a-zA-Z0-9_-]+)*$

Responses

204

Success

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

422

NTLS_INVALID_GROUP_DETECTED

Returned when the input group list contains the invalid group.

NTLS_INVALID_CIPHER_DETECTED

Returned when the input cipher list contains the invalid cipher.

Example Request

   PUT
   https://1.2.3.4:8443/api/lunasa/ntls
   {
     "receiveTimeoutTimer" : 30,
     "ipCheckEnabled" : false,
     "cipherList": "TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256",
     "groupList": "MLKEM768:MLKEM1024:SecP256r1MLKEM768:X25519MLKEM768:SecP384r1MLKEM1024"
   }

Example Result

{
}

See Also

GET /api/lunasa/ntls