Table of Contents |
---|
Purpose
State the different authentication methods available for OMK applications.
...
Key | Description | Example | Comment | |
---|---|---|---|---|
auth_htpasswd_file | Location of the password file | Default is /usr/local/nmis9/conf/users.dat | Not in GUI | |
auth_htpasswd_encrypt | Enable encrypted passwordsDefault is 1. Plain text passwords are checked ONLY if value is 0 or 'plaintext | '0/1 | Default is 1. Plain text passwords are checked ONLY if value is 0 or 'plaintext' | Not in GUI |
ldap and ldaps
You can choose to use ldap or ldaps (secure) you can not use both of these at the same time.
ldap
The Opmantek products will use the configured LDAP server to perform authentication.
...
Key | Description | Example | Comment | |||||
---|---|---|---|---|---|---|---|---|
auth_ldap_ | privsUser's local privileges | 0/1 | By default, set to 0. To enable the feature, set the value to 1. | auth_ldap_server | server | LDAP Server Name | host[:port] | The LDAP Server Name. No defaults. Entry must be created. |
auth_ldap_acc | Account Name | The LDAP account name to search forlogin to the Server. The entry must be created. | ||||||
auth_ldap_psw | Account Password | The password associated with the above LDAP account. The entry must be created. | ||||||
auth_ldap_context context | Base Context | ou=people,dc=opmantek,dc=com | Base context to attempt to bind to. | |||||
auth_ldap_attr | Username LDAP Attributes | The | LDAP attribute(s) to match to username. Can be blank; if so, it defaults to ('uid', 54.85'cn')LDAP attribute(s) to match to username. Can be blank; if so, it defaults to ('uid', 'cn') | |||||
auth_ldap_privs | Use LDAP Privileges | 0/1 | Use LDAP for Privileges and Groups. See User Authorisation with Active Directory and LDAP. By default, set to 0 (disabled). |
ldaps
The Opmantek products will use the configured LDAP (Secure) server to perform authentication.
Following are the configuration items:
Key | Description | Example | Comment | auth_ldap_privs | User's local privileges | 0/1 | By default, set to 0. To enable the feature, set the value to 1.Description | Example | Comment |
---|---|---|---|---|---|---|---|---|---|
auth_ldaps_server server | LDAPS Server Name | host[:port] | The LDAP Server Name. No defaults. Entry must be created. | ||||||
auth_ldap_acc | Account Name | The LDAP account name to login to the Server. Entry must be created | |||||||
auth_ldap_psw | Account Password | The password associated with the above LDAP account. The entry must be created. | |||||||
auth_ldap_acc | Account Name | The LDAP account name to search for. Entry must be createdcontext | Base Context | ou=people,dc=opmantek,dc=com | Base context to attempt to bind to. | ||||
auth_ldap_ | pswAccount Password | The password associated with the above LDAP account. The entry must be created.attr | Username LDAP Attributes | The LDAP attribute(s) to match to username. Can be blank; if so, it defaults to ('uid', 'cn') | |||||
auth_ldap_ | contextBase Context | ou=people,dc=opmantek,dc=com | Base context to attempt to bind to. | auth_ldap_attr | LDAP Attributes | The LDAPs attribute(s) to match to username. Can be blank; if so, it defaults to ('uid', 54.85'cn')privs | Use LDAP Privileges | 0/1 | Use LDAP for Privileges and Groups. See User Authorisation with Active Directory and LDAP. By default, set to 0 (disabled). |
ms-ldap and ms-ldaps
You can choose to use ms-ldap or ms-ldaps (secure) you can not use both of these at the same time.
ms-ldap
OMK will use the configured Microsoft Active Directory LDAP server to perform authentication.
Following are the configuration items:
Key | Description | Example | Comment | Comment | ||
---|---|---|---|---|---|---|
auth_ms_ldap_server | Microsoft LDAP Server Name | host[:port] | The LDAP Server Name. No defaults. Entry must be created. | |||
auth_ms_ldap_dn_acc | Account Name | The MS-LDAP Distinguished Name (DN)/account to login to the Server. | ||||
auth_ms_ldap_ | server dn_psw | Account Password | The password associated with the above MS-LDAP Server Name | host[:port] | No defaults. Entryaccount. The entry must be created. | |
auth_ms_ldap_accAccount Namebase | Base Context | dc=corp,dc=opmantek,dc=com | Base context to search from. | |||
auth_ms_ldap_attr | Username LDAP Attributes | sAMAccountName | The MS-LDAP Distinguished Name attribute(DNs) /account to bind withto match to username. | |||
auth_ms_ldap_ | pswAccount Password | The password associated with the above MS-LDAP account. The entry must be created. | ||||
auth_ms_ldap_base | Base Context | dc=corp,dc=opmantek,dc=com | Base context to search from. | |||
auth_ms_ldap_attr | MS-LDAP Attributes | sAMAccountName | The MS-LDAP attribute(s) to match to username. | |||
auth_ms_ldap_group | Checks if the user logging in is associated with the defined group. | Sales, SNMPSIM, GPON | Must follow: CN=OMK Ops,CN=Users,DC=opmantek,DC=localgroup | LDAP Group | Sales, SNMPSIM, GPON | Optional. The user is only allowed to log in if they are a member of the defined group. Must follow: CN=OMK Ops,CN=Users,DC=opmantek,DC=local |
auth_ldap_privs | Use LDAP Privileges | 0/1 | Use LDAP for Privileges and Groups. See User Authorisation with Active Directory and LDAP. By default, set to 0 (disabled). | |||
auth_ldap_group | Group LDAP Attribute | memberOf | Default is memberOf. The attribute to lookup the groups the user belongs to. |
ms-ldaps
The Opmantek products will use the configured Microsoft Active Directory LDAP (Secure) server to perform authentication.
...
Key | Description | Example | Comment | ||
---|---|---|---|---|---|
auth_ms_ldaps_server server | MS-Microsoft LDAPS Server Name | host[:port] | The LDAP Server Name. No defaults. Entry must be created. | ||
auth_ms_ldap_dn_acc | Account Name | The MS-LDAP Distinguished Name (DN)/account to bind withto to login to the Server. | |||
auth_ms_ldap_dn_psw | Account Password | The password associated with the above MS-LDAP account. The entry must be created. | |||
auth_ms_ldap_base base | Base Context | dc=corp,dc=opmantek,dc=com | Base context to search from. | ||
auth_ms_ldap_attr | Username LDAP Attributes | sAMAccountName | The MS-LDAP Attributes | sAMAccountName | The MS-LDAP attribute(s) to match to username. LDAP attribute(s) to match to username. |
auth_ldap_privs | Use LDAP Privileges | 0/1 | Use LDAP for Privileges and Groups. See User Authorisation with Active Directory and LDAP. By default, set to 0 (disabled). | ||
auth_ms_ldap_group Checks if the user logging in is associated with the defined group. | LDAP Group | Sales, SNMPSIM, GPON Must , GPON | Optional. The user is only allowed to log in if they are a member of the defined group. Must follow: CN=OMK Ops,CN=Users,DC=opmantek,DC=local |
...
Following are the configuration items for setting up the ConnectWise API in opCommon.json (Cannot be configured in GUI):
Key | Description | Example | Comment |
---|---|---|---|
auth_cw_server | IP address of the ConnectWise Server | 1.2.3.4 | No defaults. Entry must be created. |
auth_cw_company_id | The company name in ConnectWise | COMPANY | |
auth_cw_public_key | The ConnectWise Public Key | xxxxxxXXXXXxxxxx | |
auth_cw_private_key | The Private Key associated with the above Public Key | yyyyyYYYYYyyyyy |
...
To configure the use of openaudit authentication the following items must be configured:
Key | Description | Example | Comment |
---|---|---|---|
oae_server | IP address of the Open-AudIT server |
1.2.3.4 | The link to Open-AudIT for internal connections. Should always be the original value unless explicitly directed by Opmantek to be changed. | ||
oae_type | Unused in on-premise installations. | ||
oae_cloud_server | cloud server URL | Unused in on-premise installations. | |
omk_ua_insecure | Validation for editing remote nodes | 0 or 1 | Allows insecure (self-signed) SSL certificates |
openid_connect
Opmantek products use OKTA's OpenID Connect for authentication. In the authentication > auth_method_1 entry of opCommon.json, use the openid_connect. For more information, see OKTA OpenID authentication.
...
The Opmantek products support a new authentication method called token,
which offers delegated authentication. This enables an external party to pre-authenticate a user, who can access the Opmantek products without having to log in with username and password.
Key | Description | Example | Comment |
---|---|---|---|
auth_token_key | One or more shared keys | extusr-1Kf!yVXt8TrP9zi | |
auth_token_maxage | The maximum length of time a token will remain valid. Must be a positive number, and defines how long a token remains valid after creation (in seconds). | 60 | If not present, the default of 300 seconds is used. |
For more information on how to generate and log in with a token, see Delegated Authentication.
...
Multiple Authentication Methods
You can use up to 3 Authentication Methods authentication methods for fail back. If authentication with method 1 fails, then if they are defined, the remaining methods are tried in order. Authentication fails if they all fail. For example, if you set auth_method_1 to be LDAP and auth_method_2 to be htpasswd and login with the default NMIS credentials (and you have not changed the password), the authentication for LDAP will fail, and then htpasswd authentication with the users.dat will succeed and the NMIS user will be logged in.
Here is an example of the authentication hash inside opCommon.nmis. Remember that statements preceded by the '#' sign are 'commented out' and will not be evaluated. In this example, if ms-ldap fails, it will fail back to htpasswd.
...