Learn how to use the Wowza Streaming Engine™ media server software CLI password tool. The CLI password tool enables you to add, update, and delete users in the admin.password file. It also includes functionality for encoding passwords using Bcrypt or digest hash functions.
Notes:
- Password encoding and the CLI password tool are available in Wowza Streaming Engine 4.8.8.01 and later.
- New installations of Wowza Streaming Engine 4.8.8.01 and later automatically encode passwords using Bcrypt. To change the default password encoding method, update <PasswordEncodingScheme> in Server.xml. For more information, see Wowza Streaming Engine Server.xml configuration reference.
- The password encoding method must be compatible with the authentication method used for the REST API and HTTP providers. For more information, see Change the authentication method for the Wowza Streaming Engine REST API and Use HTTP providers with the Wowza Streaming Engine Java API.
Launch the CLI password tool
- In a Command Prompt or Terminal window, change to the directory [install-dir]/bin.
- Type the following command:
Windows:
passwordtool.bat
Linux and MacOS:
passwordtool.sh
Examples
Add a user
passwordtool --file <inputFile> --addUser --userName <username> --password <password> --groups <groups> --passwordEncoding <passwordEncoding>
Options
| Option | Description |
|---|---|
| --file <inputFile> | The full path to the admin.password file. Aliases: -f |
| --addUser | Add a new user. |
| --userName <username> | The name of the user to create. |
| --password <password> | The password for the user. |
| --groups <groups> | Assign access permissions to the user. This parameter is optional. If it's not included, the user is automatically assigned admin,advUser permissions. Supported values: admin, admin,advUser, basic, basic,advUser |
| --passwordEncoding <passwordEncoding> | The password encoding format to use. This parameter is optional. If it's not included, Wowza Streaming Engine defaults to the <PasswordEncodingScheme> specified in Server.xml. Supported values: bcrypt, md5, sha256 Note: Due to potential vulnerabilities with MD5, we recommend using sha256 with Wowza Streaming Engine. |
| --realm <realm> | The authentication realm to use. Required for digest password encoding. Wowza is the default realm for REST API and HTTP providers. |
Update a user
passwordtool --file <inputFile> --updateUser --userName <username> --password <password> --groups <groups> --passwordEncoding <passwordEncoding>
Options
| Option | Description |
|---|---|
| --file <inputFile> | The full path to the admin.password file. Aliases: -f |
| --updateUser | Update a user. |
| --userName <username> | The name of the user to update. |
| --password <password> | The password for the user. |
| --groups <groups> | Assign access permissions to the user. This parameter is optional. Supported values: admin, admin,advUser, basic, basic,advUser |
| --passwordEncoding <passwordEncoding> | The password encoding format to use. This parameter is optional. Supported values: bcrypt, md5, sha256 Note: Due to potential vulnerabilities with MD5, we recommend using sha256 with Wowza Streaming Engine. |
| --realm <realm> | The authentication realm to use. Required for digest password encoding. Wowza is the default realm for REST API and HTTP providers. |
Delete a user
passwordtool --file <inputFile> --deleteUser --userName <username>
Options
| Option | Description |
|---|---|
| --file <inputFile> | The full path to the admin.password file. Aliases: -f |
| --deleteUser | Delete a user. |
| --userName <username> | The name of the user to delete. |
