Security

The menu dedicated to security asset management such as API Key, Server Key.

Use Server Key to securely authenticate your client with Amity Social Cloud server

With secure mode off, Amity SDK generates an access token on the client side when given a userId and apiKey. This can lead to malicious users abusing the endpoint and spying on someone else's session.

With secure mode on, an additional authentication token that is generated from your own backend server using a separate Server Key is required. You must turn on secure mode in your production system or the system will be vulnerable to such kind of attack.

How to generate a server key

Amity provides a way to get the server key easily via the ASC Console as followed:

  1. Login to your ASC Console

  2. Go to Settings -> Integrations

  3. Enable secure mode via the toggle.

4. Click "Generate new server key" to generate your server key

5. A warning message will pop up. Please ensure to read it and be aware of the impact.

6. The server key will be shown, please copy and securely store into your backend system. The key will only be shown once.

User must not be a super-admin to be able to generate the key.

How to use server key to create auth token

Once secure mode is enabled and server key is generated, all client authentication request will require an authentication token and your backend server will need to make a server-to-server call, while passing server key into Amity Social Cloud server in order to get the authentication token. Please follow the following steps to generate auth token:

  1. Client initiates a call to the backend.

  2. Client's servers make a request to endpoint https://api.<region code>.amity.co/api/v4/authentication/token on SDK API server, with server key and userId. Refer to the table below for the correct region code and endpoint.

    RegionRegion codeEndpoint

    Europe

    eu

    https://api.eu.amity.co/

    Singapore

    sg

    https://api.sg.amity.co/ or https://api.amity.co/

    United States

    us

    https://api.us.amity.co/

    For EU and US, you need to specify the region in the endpoint link. For SG, however, it is optional.

  3. Receive the auth token back and find a way to pass it up from server-side to client-side and give it to the SDK.

Use your auth token in your SDK

To use auth token on the client side, please see the Getting Started guide.

How to get API key

An API key will be provided when you create the application.

  1. Open Amity Social Cloud Console.

  2. On the left menu, select Settings to expand its submenu.

  3. Select Integrations.

  4. On the Integrations page, you will find the apiKey.

API key does not contain any information of who the user is. It only contains the networkId of the network that the user is in.

Authentication

There are 2 modes of Authentication:

  1. Unsecure mode

  2. Secure mode

Unsecure mode

With secure mode disabled, you can connect directly to the Amity server.

1. Call /api/v3/session using the API key and user id. Refer to Get API key section for the instructions on how to get the API key.

curl -X 'POST' \
  'https://api.<region>.amity.co/api/v3/sessions' \
  -H 'accept: application/json' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "string",
  "deviceId": "string",
  "displayName": "string"
}'

The request body contains information about user and devices that he/she use to connect to. If displayName is provide, that user display is updated as well.

If userId doesn't exists, new user will be created.

2. In the Responses, you will find that the server will return an access token in the Response body.

Response Body
{
  "accessToken": "<accessToken>",
  "refreshToken": "<refreshToken>",
  "users": [
    {
      "_id": "<userId>",
      "path": "<userPath>",
      "updatedAt": "2022-07-20T09:59:40.854Z",
      "createdAt": "2022-07-20T09:59:40.684Z",
      "isDeleted": false,
      "displayName": "string",
      "userId": "string",
      "metadata": {},
      "roles": [],
      "permissions": [],
      "flagCount": 0,
      "hashFlag": null,
      "avatarFileId": null,
      "isGlobalBan": false
    }
  ],
  "files": []
}

Access token will be valid for 30 days. However, it will be invalidated if a different user will use the same token to register the same device.

Secure Mode

With secure mode enabled, it provides an additional layer of security because it requires server-level authentication.

If Secure mode is enabled, you will need the server key. Refer to our documentation on How to generate the server key from console.

1. Call /api/v3/authentication/token using the server key.

curl -X 'GET' \
  'https://api.<region>.amity.co/api/v3/authentication/token?userId=<userId>' \
  -H 'accept: application/json' \
  -H 'x-server-key: <your-server-key>'

Provide a userId to get a token for that user

2. The server will return an authentication token in the Response body.

Response Body
"<autenticationToken>"
  1. Authentication token will expire after ten minutes.

  2. Banning a user, whether it is on a global or channel level, will not invalidate the token.

3. Call /api/v3/session using the returned token.

curl -X 'POST' \
  'https://api.<region>.amity.co/api/v3/sessions' \
  -H 'accept: application/json' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "<userId>",
  "deviceId": "string",
  "displayName": "string",
  "authToken": "<autenticationToken>"
}'

4. In the Responses section, you will find that the server will return an access token in the Response body.

Response Body
{
  "accessToken": "<accessToken>",
  "refreshToken": "<refreshToken>",
  "users": [
    {
      "_id": "<userId>",
      "path": "<userPath>",
      "updatedAt": "2022-07-20T09:59:40.854Z",
      "createdAt": "2022-07-20T09:59:40.684Z",
      "isDeleted": false,
      "displayName": "string",
      "userId": "string",
      "metadata": {},
      "roles": [],
      "permissions": [],
      "flagCount": 0,
      "hashFlag": null,
      "avatarFileId": null,
      "isGlobalBan": false
    }
  ],
  "files": []
}
  1. Access token is different from the authentication token returned when calling /api/v3/authentication/token.

  2. Access token will be valid for 30 days. However, it will be invalidated if a different user will use the same token to register the same device.

mTLS Certificate

Mutual Transport Layer Security or mTLS, is a two-way mutual authentication technique. It helps two parties to authenticate at both ends of a network if they have the correct private key. mTLS ensures that the people at both ends of a network connection are who they claim to be.

Authentication Token and Admin Token will be protected by mTLS and provide an extra layer of security.

How to Enable mTLS Certificate

  • In the Console, go to Settings > Security tab

  • Click +Create Certificate option to create the certificate

  • In order to use this feature, you must first enable "secure mode."

  • There is a maximum upload of 2 certificates.

  • Specify the Certificate Name and Certificate Signing Request (CSR)

  • Certificate Name and Certificate Signing Request fields are mandatory.

  • Certificate Name can be up to 30 characters.

  • Activate the mTLS feature

We strongly recommend that you enable the mTLS feature only after the certificate has been created.

Enabling the mTLS feature is optional.

Last updated