API Rest

General description

KalliopePBX offers several REST APIs that can be invoked by external systems to execute device actions (e.g. creating extensions, generating and downloading backups, etc.) or consultation actions (e.g. downloading the CDR, etc.).

APIs can be accessed through HTTP or HTTPS with authentication, following the mechanism described below.

Authentication mechanism

The REST API authentication mechanism uses the same user credentials as those needed to access the web. Specifically, each request must contain a custom single-use HTTP header named X-authenticate. The authentication procedure is one-way, i.e. it does not require the server to send a challenge, and all information necessary for authentication is generated from the client side.

Because the headers are single use, knowledge of the X-authenticate header of a request does not allow one to send an illicit request, thus preventing replication attacks.

X-authenticate header construction

The header is comprised of a sequence of data and a digest constructed from that data along with the password of the user making the request. Here is an example of a complete X-authenticate header:

X-authenticate: RestApiUsernameToken Username="admin", Domain="default", Digest="+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=", Nonce="bfb79078ff44c35714af28b7412a702b", Created="2016-04-29T15:48:26Z"

The information transmitted in the request are:

  • Username: the username assigned to the user (e.g. admin).

  • Domain: the domain of the tenant that the user belongs to. In single-tenant systems, the predefined domain is “default”.

  • Nonce: a random hexadecimal string of at least 8 characters generated by the client. A new one must be generated for each request, as the system keeps track of all previously used nonces for their lifetime of 5 minutes. After 5 minutes, it is possible to reuse a nonce; protection from attacks will be guaranteed by the nonce creation timestamp.

  • Created: the nonce creation timestamp; if the time of reception differs from the time set on KalliopePBX by more than 5 minutes, the request will be considered invalid and refused. This guarantees that an X-authenticate header cannot be reused at any time. The timestamp format is “YYYY-MM-DDThh:mm:ssZ” (UTC timezone).

The Digest field is a hash of the above data along with the user password, generated by applying the SHA-256 hash algorithm to the concatenation (with no delimiters) of Nonce, digestPassword, Username, Domain, and Created:

Digest = sha256(Nonce + digestPassword + Username + Domain + Created)

Since KalliopePBX saves passwords in the form of non-reversible hashes, the digest must be generated using the hash of the password obtained using the same method as KalliopePBX (digestPassword).

The hash function that produces the digestPassword requires the user password and a salt string, which is unique for each tenant. The salt can be obtained from KalliopePBX with a designated REST API that can be invoked anonymously (i.e. without authentication):

rest/salt/<dominio_tenant>

where the string <dominio_tenant>, in the case of a single tenant machine, is “default”. In the case of multi-tenant system, in order to use the API available to pbxadmin, it is possible to obtain the relative salt through the API

rest/salt/pbxAdmin

The formula is as follows (the { e } characters are part of the string to which SHA-256 is applied and must be inserted):

digestPassword = sha256(password{<salt>})

For example, if the password is “admin” and the salt is “b5a8fdcf2f8d5acdad33c4a072a97d7a”, the resulting digestPassword is

digestPassword = sha256(admin{b5a8fdcf2f8d5acdad33c4a072a97d7a}) = dd7b0be7fa37d6cbaf0b842bf7532f229cb79ab8d54d509c2aa7eea27a53cd5e

So the following information:

Nonce: bfb79078ff44c35714af28b7412a702b
digestPassword: dd7b0be7fa37d6cbaf0b842bf7532f229cb79ab8d54d509c2aa7eea27a53cd5e
Username: admin
Domain: default
Created: 2016-04-29T15:48:26Z

will result in:

Digest = base64(sha256binary(bfb79078ff44c35714af28b7412a702bdd7b0be7fa37d6cbaf0b842bf7532f229cb79ab8d54d509c2aa7eea27a53cd5eadmindefault2016-04-29T15:48:26Z))

which is +PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=.

Note

sha256binary(..) is the sha256(..) function that outputs a binary string rather than a hexadecimal one.

The complete string to insert in the header is therefore: .. code-block:: console

X-authenticate: RestApiUsernameToken Username=”admin”, Domain=”default”, Digest=”+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=”, Nonce=”bfb79078ff44c35714af28b7412a702b”, Created=”2016-04-29T15:48:26Z”

API list

For firmware versions up to 4.8.x, the updated API list can be viewed at

http[s]://KALLIOPE_IP_ADDRESS/api/doc

Starting from firmware version 4.9.4 it is also available a Postman collection (that replaces the sandbox integrated in the documentation page); this collection integrates the code to automatically add the required authentication header (it is necessary only to set the IP address of the PBX and the username/password credentials of the user to invoke the API).

Accessing the KalliopeTribe provides a video demonstrating the use of that collection to quickly invoke the Kalliope API.

The collection file can be downloaded from these links:

You can download the file with API swagger specification from KalliopePBX, here:

http[s]://KALLIOPE_IP_ADDRESS/api/doc.json

Classes for generating authentication headers

Listed below are projects in different programming languages for generating and validating authentication headers.

  • phpRestApiUtils: implementation in PHP

  • RegEx: regular expression useful for validating generated headers