AUTH_JWT Module


Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. db_url (string)
1.3.2. profiles_table (string)
1.3.3. secrets_table (string)
1.3.4. tag_column (string)
1.3.5. username_column (string)
1.3.6. secret_tag_column (string)
1.3.7. secret_column (string)
1.3.8. start_ts_column (string)
1.3.9. end_ts_column (string)
1.3.10. tag_claim (string)
1.3.11. load_credentials (string)
1.4. Exported Functions
1.4.1. jwt_authorize(jwt_token,out_decoded_token,out_sip_username)
2. Contributors
2.1. By Commit Statistics
2.2. By Commit Activity
3. Documentation
3.1. Contributors

List of Tables

2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
2.2. Most recently active contributors(1) to this module

List of Examples

1.1. db_url parameter usage
1.2. profiles_table parameter usage
1.3. secrets_table parameter usage
1.4. Set tag_column parameter
1.5. Set username_column parameter
1.6. Set secret_tag_column parameter
1.7. set secret_column parameter
1.8. set start_ts parameter
1.9. set end_ts parameter
1.10. set tag_claim parameter
1.11. load_credentials parameter usage
1.12. www_authorize usage

Chapter 1. Admin Guide

1.1. Overview

The module implements authentication over JSON Web Tokens. In some cases ( ie. WebRTC ) the user authenticates on another layer ( other than SIP ), so it makes no sense to double-authenticate it on the SIP layer. Thus, the SIP client will simply present the JWT auth token it received from the server, and pass it on to OpenSIPS which will use that for authentication purposes. It relies on two DB tables, one containing JWT profiles ( a profile name and it's SIP username associated to it ) and one containing JWT secrets. Each secret has a corresponding profile, the KEY used for signing the JWT and two timestamps describing a validation interval. Multiple JWT secrets can point to the same JWT profile.

1.2. Dependencies

1.2.1. OpenSIPS Modules

The module depends on the following modules (in the other words the listed modules must be loaded before this module):

  • database -- Any database module (currently mysql, postgres, dbtext)

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • libjwt-dev

1.3. Exported Parameters

1.3.1. db_url (string)

This is URL of the database to be used. Value of the parameter depends on the database module used. For example for mysql and postgres modules this is something like mysql://username:password@host:port/database. For dbtext module (which stores data in plaintext files) it is directory in which the database resides.

Default value is mysql://opensipsro:opensipsro@localhost/opensips.

Example 1.1. db_url parameter usage

modparam("auth_jwt", "db_url", "dbdriver://username:password@dbhost/dbname")

1.3.2. profiles_table (string)

Name of the DB table containing the jwt profiles

Default value of this parameter is jwt_profiles.

Example 1.2. profiles_table parameter usage

modparam("auth_jwt", "profiles_table", "my_profiles")

1.3.3. secrets_table (string)

Name of the DB table containing the jwt secrets

Default value of this parameter is jwt_secrets.

Example 1.3. secrets_table parameter usage

modparam("auth_jwt", "secrets_table", "my_secrets")

1.3.4. tag_column (string)

Column holding the JWT profile tag.

Default value is tag.

Example 1.4. Set tag_column parameter

...
modparam("auth_jwt", "tag_column", "my_tag_column")
...

1.3.5. username_column (string)

Column holding the JWT profile associated SIP username.

Default value is sip_username.

Example 1.5. Set username_column parameter

...
modparam("auth_jwt", "username_column", "my_username_column")
...

1.3.6. secret_tag_column (string)

Column holding the JWT secret associated tag.

Default value is corresponding_tag.

Example 1.6. Set secret_tag_column parameter

...
modparam("auth_jwt", "secret_tag_column", "my_secret_tag_column")
...

1.3.7. secret_column (string)

Column holding the actual jwt signing secret.

default value is secret.

Example 1.7. set secret_column parameter

...
modparam("auth_jwt", "secret_column", "my_secret_column")
...

1.3.8. start_ts_column (string)

Column holding the JWT secret start UNIX timestamp.

default value is start_ts.

Example 1.8. set start_ts parameter

...
modparam("auth_jwt", "start_ts", "my_start_ts_column")
...

1.3.9. end_ts_column (string)

column holding the jwt secret end unix timestamp.

default value is end_ts.

Example 1.9. set end_ts parameter

...
modparam("auth_jwt", "end_ts", "my_end_ts_column")
...

1.3.10. tag_claim (string)

The JWT claim which will be used to identify the JWT profile

default value is tag.

Example 1.10. set tag_claim parameter

...
modparam("auth_jwt", "tag_claim", "my_tag_claim")
...

1.3.11. load_credentials (string)

This parameter specifies credentials to be fetched from the JWT profiles table when the authentication is performed. The loaded credentials will be stored in AVPs. If the AVP name is not specificaly given, it will be used a NAME AVP with the same name as the column name.

Parameter syntax:

  • load_credentials = credential (';' credential)*

  • credential = (avp_specification '=' column_name) | (column_name)

  • avp_specification = '$avp(' + NAME + ')'

Default value of this parameter is none ( empty ).

Example 1.11. load_credentials parameter usage

# load my_extra_column into $avp(extra_jwt_info)
modparam("auth_jwt", "load_credentials", "$avp(extra_jwt_info)=my_extra_column")

1.4. Exported Functions

1.4.1.  jwt_authorize(jwt_token,out_decoded_token,out_sip_username)

The function will read the first param ( jwt_token ), extract the tag claim and then try to authenticate it against the DB secrets for the respective profile tag. In case of success, it populates the out_decoded_token pvar with the decoded JWT ( in plaintext format header_json.payload_json ) and the out_sip_username with the SIP username corresponding to that JWT profile.

Negative codes may be interpreted as follows:

  • -1 ( error) - JWT authentication failed

Meaning of the parameters is as follows:

  • jwt_token (string) - The JWT token to perform auth on

    The string may contain pseudo variables.

  • out_decoded_token (pvar) - PVAR used to store the decoded JWT upon succesful auth

  • out_sip_username (pvar) - PVAR used to store the SIP username corresponding to the JWT profile, upon succesful auth

This function can be used from REQUEST_ROUTE.

Example 1.12. www_authorize usage

...
if (!jwt_authorize("$avp(my_jwt_token)", $avp(decoded_token), $avp(sip_username) )) {
	send_reply("401","Unauthorized");
	exit;
} else {
	xlog("Succesful JWT auth - $avp(decoded_token) \n");
	if ($fU != $avp(sip_username)) {
		send_reply("403","Forbidden AUTH ID");
		exit;
	}	
}
...

Chapter 2. Contributors

2.1. By Commit Statistics

Table 2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)

 NameDevScoreCommitsLines ++Lines --
1. Vlad Paiu (@vladpaiu)12211360
2. Bogdan-Andrei Iancu (@bogdan-iancu)2104

(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)

(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".

(3) ignoring whitespace edits, renamed files and auto-generated files

2.2. By Commit Activity

Table 2.2. Most recently active contributors(1) to this module

 NameCommit Activity
1. Vlad Paiu (@vladpaiu)Mar 2020 - Mar 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu)Mar 2020 - Mar 2020

(1) including any documentation-related commits, excluding merge commits

Chapter 3. Documentation

3.1. Contributors

Last edited by: Vlad Paiu (@vladpaiu).