Skip to content

Latest commit

 

History

History
132 lines (104 loc) · 4.91 KB

README.md

File metadata and controls

132 lines (104 loc) · 4.91 KB
Raw

jitsi-token-service

This project provides an implementation of a token provider for the Jitsi JWT authentication mechanism for self-hosted Jitsi Meet installations. In particular, it also is able to generate moderator tokens for the token_affiliation plugin.

This effectively allows you to provide an external login system for authenticating Jitsi moderators (without the need)

Configuration

Environment

This section describes the environment variables which are used to configure the token service:

  • COOKIE_NAME (required): Name of the moderator cookie (example: jitsi_mod_jwt)
  • JWT_VALIDITY (default: 1h): Duration for which the generated token should be valid for (example: 1h30m, 300s)
  • JWT_APP_SECRET (required): Secret JWT signing string, this value needs to match the one configured in Jitsi meet (example: my_jitsi_app_secret)
  • JWT_APP_ID (required): JWT issuer, this value needs to match the one configured in Jitsi meet (example: my_jitsi_app_id)
  • JWT_AUDIENCE (default: jitsi): JWT audience, this value needs to match the one configured in Jitsi
  • JWT_LEEWAY (default: 1m): Maximum clock drift allowed for JWT validation
  • PUBLIC_URL (required): Jitsi Meet base URL (without the room identifier) (example: https://meet.jitsi)
  • HTML_DOCROOT (default: ./html): Directory containing the HTML login form template
  • HTML_TITLE (default: Jitsi Moderator Login): HTML title displayed to the user on the login form
  • MODS_FILE (default: ./mods.htpasswd): Path to the htaccess file containing the list of all authorized moderators with their password hash
  • HTTP_ADDR (default: :8080): Address on which the HTTP server will listen on

Moderators File

The MODS_FILE environment variable must point to a text file in the htaccess format containing all authorized moderators with their accompanying password hashes. Use one line per username and pasword pair. Empty lines or comment lines (starting with #) are allowed.

The password hash needs to be a bcrypt hash (cost 11 or higher is recommended).

# example mods.htaccess file:
bob:$2y$12$EAZVfUzqmzqloNbfRAqY.e295IjhfHI/Ma2Tezqk8DryRZnkOT792
alice:$2y$12$ianjnXNNHVQwiy3R15NsiO.lC04uEG7SEzP6qv/Rs1NZmNyPB6Muu

Note

The moderator file username is only used for authentication and is not forwarded to Jitsi Meet in any form. Moderators may use a different username as their "Display Name" when joining a Jitsi Meet room.

Jitsi

For details on how to configure your self-hosted instance of Jitsi, please refer to the Jitsi documentation. The following example illustrates what values may be relevant when using jitsi/docker-jitsi-meet:

# Enable JWT authentication
ENABLE_AUTH=1
AUTH_TYPE=jwt

# JWT identifier and secret (shared between Jitsi and the token service)
JWT_APP_ID=my_jitsi_app_id
JWT_APP_SECRET=my_jitsi_app_secret # important: change this!

# URL to this token service
TOKEN_AUTH_URL=https://auth.jitsi:8080/autologin?room={room}

# Enable the token_affiliation Prosody plugin
XMPP_MUC_MODULES=token_affiliation

Login Flow

sequenceDiagram
    participant Browser as User Agent
    participant Auth as Jitsi Token Service<br>(auth.jitsi)
    participant Jitsi as Jitsi Meet<br>(meet.jitsi)

    opt Moderator Login
        activate Browser

        Browser->>+Auth: GET https://auth.jitsi/login
        Auth-->>-Browser: Login Page

        Note over Browser: User provides<br>username and password

        Browser->>+Auth: POST https://auth.jitsi/login
        Note over Auth: Verifies username and password
        Note over Auth: Generates and signs JWT<br>(with `moderator:true` claim)
        Auth-->>-Browser: Store JWT in cookie

        deactivate Browser
    end

    activate Browser
    Browser->>+Jitsi: https://meet.jitsi/<room>
    Note over Jitsi: User is not authenticated.<br>Deny user to join room
    Jitsi-->>-Browser: Redirect to Jitsi Token Service

    Browser->>+Auth: GET https://auth.jitsi/autologin?room=<room>
    alt Cookie provided
        Note over Auth: Verifies cookie and JWT.<br>Reuses JWT if valid
    else Cookie missing<br>or invalid
        Note over Auth: Generates and signs new JWT<br>(without moderator claim)
    end
    Auth-->>-Browser: Redirect to Jitsi Meet (with JWT)

    Browser->>+Jitsi: https://meet.jitsi/<room>?jwt=<JWT>
    Note over Jitsi: Verifies JWT signature
    alt `moderator:true`
        Note over Jitsi: Allow user to join and<br>grant moderator rights
    else `moderator:false`
        Note over Jitsi: Allow user to join
    end
    Jitsi-->>-Browser: Join room

    deactivate Browser
Loading