Security

Aculab cloud requires that web service requests are made in a secure manner.

Note

 This is a low level API. For information on higher level APIs see the Web Services Language Wrappers

Authorisation

This API uses basic authentication, using your cloud account username and API Access Key.

Username	: cloudID/username (e.g. 1-2-0/bob@example.com)
Password	: API Access Key

Protocol Check

This is used to check if the security protocol use for web service requests is sufficiently secure.

Request

URL	: https://ws-[cloudID].aculabcloud.net/security/protocol_check
Methods	: GET, POST

Response

A JSON object containing the result of the security protocol check and other diagnostic information.

Parameter	Value	Description
pass	boolean	true if the connection is secure, false otherwise.
protocol	string	the protocol used, e.g. TLSv1.2.
cipher	string	the cipher used.
user_agent	string	the User-Agent header passed in the request. If the header was not present, an empty string is returned
source_address	string	the source address of the request that reached the web services server.
reason	string	a description of the cause of a failed check. Not present if the check passed.

Example

Request

https://ws-[cloudID].aculabcloud.net/security/protocol_check

Response

  {
    "pass": true,
    "protocol": "TLSv1.2",
    "cipher": "ECDHE-RSA-AES128-GCM-SHA256",
    "user_agent": "Aculab PHP Web Services wrapper v1.0.5 (PHP 7.4.4, OpenSSL 1.1.1d  10 Sep 2019, WINNT)",
    "source_address": "203.0.113.34"
  }