RUI3 (RAK Unified Interface 3) - RAK4631
bg77::qsslcfg

Public Member Functions

String get (String, int)
 
String set (String, int, int)
 
String set (String, int, String)
 

Member Function Documentation

◆ get()

String get ( String  ,
int   
)
Description
This api configures the SSL version, cipher suite, security level, CA certificate, client certificate and client key.
Syntax
bg77.qsslcfg.get(para,SSL_ctxID)
Parameters
paraString String type.
  • "sslversion"
  • "ciphersuite"
  • "cacert"
  • "clientcert"
  • "clientkey"
  • "seclevel"
  • "session"
  • "sni"
  • "checkhost"
  • "ignorelocaltime"
  • "negotiatetime"
  • "renegotiation"
  • "dtls"
  • "dtlsversion"
SSL_ctxIDint Integer type. SSL context ID. Range: 0–5
Returns
String response

◆ set() [1/2]

String set ( String  ,
int  ,
int   
)
Description
This api configures the SSL version, cipher suite, security level, CA certificate, client certificate and client key.
Syntax
bg77.qsslcfg.set(para,SSL_ctxID,conf)
Parameters
paraString String type.
  • "sslversion"
  • "seclevel"
  • "session"
  • "sni"
  • "checkhost"
  • "ignorelocaltime"
  • "negotiatetime"
  • "renegotiation"
  • "dtls"
  • "dtlsversion"
SSL_ctxIDint Integer type. SSL context ID. Range: 0–5
confint
  • "sslversion" int Integer type. SSL Version.
    • 0 SSL3.0
    • 1 TLS1.0
    • 2 TLS1.1
    • 3 TLS1.2
    • 4 All
  • "seclevel" int Integer type. Authentication mode.
    • 0 No authentication
    • 1 Perform server authentication
    • 2 Perform server and client authentication if requested by the remote server
  • "session" int Integer type. Enable or disable SSL Resumption feature.
    • 0 Disable
    • 1 Enable
  • "SNI" int Integer type. Enable or disable Server Name Indication feature. DNS hostnames are currently the only supported server names.
    • 0 Disable
    • 1 Enable
  • "checkhost" int Integer type. Enable or disable hostname validation feature (Subject Common Name (CN) matches the specified host name).
    • 0 Disable
    • 1 Enable
  • "ignorelocaltime" int Integer type. Whether or not to ignore certificate validity check.
    • 0 Not to ignore
    • 1 Ignore
  • "negotiatetime" int Integer type. The maximum timeout of SSL negotiation. Range: 10–300. Default value: 300. Unit: second.
  • "renegotiation" int Integer type. Enable or disable support for TLS renegotiation.
    • 0 Disable
    • 1 Enable
  • "dtls" int Integer type. Enable or disable DTLS feature.
    • 0 Disable
    • 1 Enable
  • "dtlsversion" int Integer type. DTLS version.
    • 0 DTLS1.0
    • 1 DTLS1.2
    • 2 Both
Returns
String response

◆ set() [2/2]

String set ( String  ,
int  ,
String   
)
Description
This api configures the SSL version, cipher suite, security level, CA certificate, client certificate and client key.
Syntax
bg77.qsslcfg.set(para,SSL_ctxID,conf)
Parameters
paraString String type.
  • "ciphersuite"
  • "cacert"
  • "clientcert"
  • "clientkey"
SSL_ctxIDint Integer type. SSL context ID. Range: 0–5
confString
  • "ciphersuite" String Numeric type in HEX format. SSL cipher suites.
    • 0X0035 TLS_RSA_WITH_AES_256_CBC_SHA
    • 0X002F TLS_RSA_WITH_AES_128_CBC_SHA
    • 0X0005 TLS_RSA_WITH_RC4_128_SHA
    • 0X0004 TLS_RSA_WITH_RC4_128_MD5
    • 0X000A TLS_RSA_WITH_3DES_EDE_CBC_SHA
    • 0X003D TLS_RSA_WITH_AES_256_CBC_SHA256
    • 0XC002 TLS_ECDH_ECDSA_WITH_RC4_128_SHA
    • 0XC003 TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
    • 0XC004 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
    • 0XC005 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
    • 0XC007 TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
    • 0XC008 TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
    • 0XC009 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    • 0XC00A TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
    • 0XC011 TLS_ECDHE_RSA_WITH_RC4_128_SHA
    • 0XC012 TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
    • 0XC013 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
    • 0XC014 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
    • 0XC00C TLS_ECDH_RSA_WITH_RC4_128_SHA
    • 0XC00D TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
    • 0XC00E TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
    • 0XC00F TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
    • 0XC023 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
    • 0XC024 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
    • 0XC025 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
    • 0XC026 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
    • 0XC027 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • 0XC028 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
    • 0XC029 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
    • 0XC02A TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
    • 0XC02B TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
    • 0XC02F TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
    • 0XC0A8 TLS_PSK_WITH_AES_128_CCM_8
    • 0X00AE TLS_PSK_WITH_AES_128_CBC_SHA256
    • 0XC0AE TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8
    • 0XFFFF Support all
  • "cacertpath" String String type. The path of the trusted CA certificate.
  • "clientcertpath" String String type. The path of the client certificate.
  • "clientkeypath" String String type. The path of the client private key.
Returns
String response