miniOrange Two Factor Authentication (2FA) SSH Module provides a secure way to login into the linux servers that enhance the security and makes the brute force attacks more difficult.
Two Factor Authentication (2FA) on top of SSH Access, adds an extra layer of security to increase the identity assurance and reduce risk and exposure.
miniOrange Two Factor Authentication (2FA) module can be installed on Linux operating systems
to add Two-Factor authentication on the top of local and Remote login.
miniOrange supports following Authentication Methods for Two Factor Authentication (2FA):
The Module has been well tested on the following Linux distributions.
( If you have other than the following mentioned distributions please contact us )
RHEL based systems e.g. Red Hat, CentOS
We can connect with any External IDP/Directory
miniOrange provides user authentication from external directories like ADFS, Microsoft Active Directory, Azure AD, OpenLDAP, Google, AWS Cognito etc. It also provides user authentication with other IDPs like Shibboleth, PING, Okta, OneLogin, KeyCloak and many more.
From the Side Menu, Click on User Stores >> Add User Store
Select User Store type as AD/LDAP.
STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway in your premise.
Enter LDAP Display Name and LDAP Identifier of your choice. Select Directory Type as Active Directory.
Enter the LDAP Server URL or IP Address against LDAP Server URL field.
Go to AD FS-> Domain-> respective Users -> Properties-> Attribute Editor. Now copy the value of distinguishedName and paste it against Bind Account DN.
Enter the valid password for the user from above step.
Search Base is the location in the directory where the search for a user begins.
If you want to add extra conditions on user search you can add it in Search Filter. Select a suitable Search Filter from the Drop-Down. To use custom Search Filter select "Custom Search Filter" option and provide the search filter in the input field that shows up.
You can also configure following options while setting up AD.
Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.
All user authentications will be done with LDAP credentials if you Activate it
Sync users in miniOrange
Users will be created in miniOrange after authentication with LDAP
If LDAP credentials fail then user will be authenticated through miniOrange
Allow users to change password
This allows your users to change their password. It updates the new credentials in your LDAP server
Enable administrator login
On enabling this, your miniOrange Administrator login authenticates using your LDAP server
Show IdP to users
If you enable this option, this IdP will be visible to users
Send Configured Attributes
If you enable this option, then only the attributes configured below will be sent in attributes at the time of login
Click on Save. After this, it will show you the list of User stores. Click on Test Configuration to check whether you have enter valid details. For that, it will ask for username and password.
On Successful connection with LDAP Server, a success message is shown.
Click on Test Attribute Mapping.
Enter a valid Username. Then, click on Test. Mapped Attributes corresponding to the user are fetched.
After successful Attribute Mapping Configuration, go back to the ldap configuration and enable Activate LDAP in order to authenticate users from AD/LDAP.
Here, fill the user details without the password and then click on the Create User button.
Click on On Boarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.
Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
On the next screen, enter the password and confirm password and then click on the Single Sign On (sso)reset password button.
Now, you can log in into miniOrange account by entering your credentials.
1.2.2 Bulk Upload Users in miniOrange via Uploading CSV File.
Navigate to Users >> User List. Click on Add User button.
In Bulk User Registration download sample csv format from our console and edit this csv file according to the instructions.
To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.
After uploading the csv file successfully, you will see a success message with a link.
Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.
1.2.3 Self User Registration
miniOrange self user registration allows end users to register themselves using customized registration form. miniOrange admin users can customize the registration form by adding more custom fields accodring to their choice. Learn More
Step 2: Configuring Two Factor Authentication (2fa)
Login into your End-User Dashboard using Active Directory Credentials.
Select Configure 2FA from left panel.
Browse through the Second factor options and choose an appropriate method to be used by the particular End-User during login.
In this guide, we have selected the method "OTP OVER SMS". You can explore the guide to setup other methods here.
Click on configure/reconfigure "OTP OVER SMS".
Enter you phone number along with the necessary country code and click on SAVE below. After the Phone details are saved successfully, click on the Save button on the top bar to set this as your 2FA method.
To use a particular method of 2FA, we configure that method first and then select the method and click on SAVE.
Currently used method is denoted by green color.
Click Here to configure the 2FA method from miniOrange Admin dashboard.
Click here for step by step guide to configure 2FA methods for end-users .
Step 3: Configure MO-SSH Module
Install the following extensions which are required to proceed for further configuration.
curl, jq & python
Download the “mo-ssh” file.
Open your Linux terminal and make sure you are the root user.
Execute the following command to install “mo-ssh” module.
# bash mo-ssh install < path > e.g. # bash mo-ssh install /usr/local/bin
Enter the miniOrange account credentials.
Proceed for the following steps once you have successfully logged in.
Execute the below command to enable the Two Factor Authentication (2FA) for the users.
‹path of mo-ssh file› enable ‹local_username› ‹miniOrange_email› e.g. # /usr/local/bin enable ec2-user firstname.lastname@example.org
Two Factor Authentication (2fa) is now enabled for the user. You can now test your 2fa setup.
In case you have set OTP over SMS 2FA method. Enter the otp that you will recieve on your phone number. Please enter the otp.
After entering the correct otp the test authentication will be successful.
In case you have set Google Authenticator 2FA method. You will need to enter the token number.
Enter the token number from google authenticator app. The test authentication will be successful.
Execute the below command to restart the sshd service.
$ service sshd restart
Step 4: Test your setup
Initiate SSH into your system and enter your username. It will prompt for the two factor authentication (2fa) verification.
If you have set OTP over SMS 2FA method. Enter the otp will recieve on your phone number.
After entering the correct otp the authentication will be successful.
If you have set Google Authenticator 2FA method. You will need to enter the token number.
Enter the token number from google authenticator app. The authentication will be successful.
Execute the below command to uninstall the module. # < path > mo-ssh uninstall e.g. # /usr/local/bin/mo-ssh uninstall