Overview
This document describes how to use PhenixID test tool. PhenixID Test tool is included in PhenixID Multi-Factor Authentication (MFA). The Test tool could be used to verify RADIUS communication, smtp settings, LDAP settings, PhenixID Licenses etc.
Start PhenixID Test tool
- Open folder drive:\..\PhenixID\Server\bin
- Execute testtool.sh/testtool.bat
Using PhenixID Test tool
All results will be displayed in the text area on the right hand side of Test tool.
General tab
The general tab is used for checking the PhenixID license file and to test communication. Global http proxy settings will also be configured on this tab.
HTTP Proxy Settings
Setting | Description | Example |
Proxy Host | The dns name or ip address of your proxy server | 192.168.8.20 |
Proxy Port | The proxy port to be used | 8080 |
Proxy User | The username to be used for the proxy server, if any. | SrvProxy |
Proxy Pwd | The password for the user configured in previous comment | P455w0rd |
Show pwd | Show password written in previous step. | |
Set proxy settings | Configure Test tool to use the configured settings |
Protocol Test
The protocol test section consist of two parts; HTTP and Telnet.
HTTP
Setting | Description | Example |
Host | The dns name or ip address to test | https://msggweu.phenixidentity.com |
Port | The port to be used | 443 |
Use proxy settings | Tells Test tool to use proxy settings configured in previous step. | |
Send GET request | Will send a http GET request to the host and port configured. |
Telnet
Setting | Description | Example |
Host | The dns name or ip address to test | msggweu.phenixidentity.com |
Port | The port to be used | 443 |
Connect | Will try a telnet connect to the host and port specified |
License Check
The online license check will check the p12 license file and verify if it is valid.
Setting | Description | Example |
License File | The p12 license file to check | license.p12 |
Keystore password | Optional. Only to be configured if the p12 has been modified after receiving the file from PhenixID. | EMPTY |
Check License | Will perform the license check |
Example response from server when a valid license is checked:
License file for customer: <customername> Allowed for continuous usage.
LDAP tab
The LDAP tab is for testing the LDAP connection, as well as the LDAP search filters.
LDAP Server Settings
Setting | Description | Example |
IP Address | The dns name or ip address of your LDAP server | 192.168.8.20 |
Port | The LDAP port to be used | 636 |
SSL | If an encrypted connection with the LDAP server should be used | TRUE |
Admin DN | The distinguished name for the proxy account to be used | cn=administrator,cn=users,dc=company,dc=local |
Password | Password for the proxy account | TopSecret |
Show pwd | Show password written in previous step. | |
Test LDAP connection | Will do an LDAP Bind, using the parameters configured |
Search Settings
Setting | Description | Example |
Search base | The DN used as base when searching | dc=company,dc=local |
LDAP filter | The LDAP filter used when searching | (&(sAMAccountName=JDoe)(mobile=*)) |
Attributes | MANDATORY. Attributes to fetch from the LDAP object(s) matching the configured filter | mobile,mail,cn |
Search scope | Search scope to be used (BASE, ONE, SUB) | SUB |
Test LDAP search | Will do an LDAP Search, using the parameters configured in LDAP Server settings and Search Settings |
SMS / SMTP
The SMS / SMTP tab is used to test and verify communication with PhenixID Message Gateway and the SMTP server used. The proxy server will be used if configured on the general tab.
PhenixID Message Gateway Settings
Setting | Description | Example |
URL | The URL to PhenixID Message Gateway | https://msggweu.phenixidentity.com/phenixidsms/phenixidsms |
Username | The username used for authentication to PhenixID Message Gateway, received from PhenixID. | CustomerID |
Password | The Password received from PhenixID. | Toptopsecret |
Show pwd | Display the value | |
Authenticate | Will test to authenticate to the service with the parameters configured. | 0 : OK – If working as desired |
Mobile | Mobile phone number to be used for testing the SMS service | +4670121212 |
Send SMS | Will test to send a SMS to the mobile number provided using the parameters configured. | SMS Text: Test Message |
Send Voice | Will test to send a Voice message to the mobile number provided using the parameters configured. | Voice Message: 1 2 3 4 |
SMTP Settings
Setting | Description | Example |
SMTP Host | The dns name or ip address of your SMTP server | 127.0.0.1 |
SMTP Port | The port used by the SMTP service | 25 |
User name | The user name for authentication. Only if authenticated relay is used | |
Password | The password for authentication. Only if authenticated relay is used | |
Show pwd | Display the value | |
Start TLS | ||
SSL on connect | ||
Check server identity | Check if server name is matching the cn from the certificate | |
From | The sender e-mail address | donald.duck@company.org |
To | The recipient e-mail address | mickey.mouse@company.org |
Send Mail | Sends the mail | Subject: Test mail subject |
RADIUS
The RADIUS tab is used to test communication with the RADIUS server.
Server Settings
Configure Test tool to communicate with the RADIUS server
Setting | Description | Example |
IP Address | The dns name or ip address of your RADIUS server | 192.168.8.20 |
Port | The RADIUS port to be used | 1812 |
Secret | The RADIUS pre shared key configured on your RADIUS server | ToPSecreTT |
Show secret | Display the value | |
Timeout | Number of seconds before timing out | 5 |
Client Settings
Configure the “client parameters” that Test tool should send to the RADIUS server
Setting | Description | Example |
User name | User name to send to RADIUS server | JDoe |
Password | Password for username previously entered | TopSecre |
Show pwd | Display the value | |
OTP | The OTP, either received through SMS/SMTP or generated using token | |
State | The state, returned from the RADIUS server | |
RADIUS Attributes | Displays a list of the additional RADIUS attributes to be sent to the server. Use the “Add” and “Remove attribute” buttons to modify the list. | 44: SMS |
Legacy API
This panel is used when testing the functionality of the “Legacy API”.
Server Settings
Setting | Description | Example |
IP Address | The dns name or ip address of your legacy API server | 192.168.8.20 |
Port | The Legacy API port to be used, default is 3100 | 3100 |
Client name | The Legacy API client name that will be used for name mapping in configuration | PSS |
Encrypt data | If encryption is used or not. |
Communication
Select desired Command to send to the Legacy API. Additional configuration might be necessary depending on selected command to use.
About
Information about version of PhenixID Test tool and link to this documentation.
DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.
PhenixID - support.phenixid.se