Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
two-auth
Advanced tools
Readme
Two-Auth simplifies the process of implementing two-factor SMS authentication for your application. Two-Auth provides a simplified wrapper for Twilio’s verify API 2.0.
Two-Auth comes out of the box with one constructor function and three primary methods to create
your registered user, send
your user a verification code, and verify
your user's code.
In your terminal, type:
$ npm install --save two-auth
If you have not already, make sure to sign up for a Twilio account to receive your API credentials. You can sign up for Twilio here: https://www.twilio.com/try-twilio.
In your application's backend, likely in an Express middleware controller (or wherever you manage authentication), require 'two-auth.' Then invoke the twoAuth function with your API credentials: your Twilio Account SID and your Twilio Auth Token.
const twoAuth = require('two-auth');
const client = twoAuth(*ACC_SID*, *AUTH_TOKEN*);
Optionally: you may pass a third parameter
options
object with the following syntax:
const twoAuth = require('two-auth');
const options = {
appName: "*YOUR_APP_NAME*",
isPostgres: boolean,
connectionURI: "*MONGO_URI or POSTGRES_URI*",
}
const client = twoAuth(*ACC_SID*, *AUTH_TOKEN*, options);
Based on your options object, your users will be sent sms with your
appName
. We currently support Mongo and Postgres databases.If
isPostgres
is set tofalse
we store your SID, registered user IDs and phone numbers inside a collection on your passed in Mongo database under the nametwo auth users
.If
isPostgres
is set totrue
we store your SID, registered user IDs and phone numbers inside a table on your passed in Postgres database under the nametwoauthusers
.
The initialization function will return an instance of a Two-Auth client
. That client
will have the create
, send
, and verify
methods.
Note: each of these methods are fully asynchronous and should occur at different points in your express middleware controller pattern. The methods each return a promise.
create()
Provide two-auth with a user ID and a phone number associated with that user.
client.create(*USER_ID*, *PHONE_NUMBER*);
Warning: Two-Auth currently only supports US phone numbers. They must be formatted as a string to match +1XXXXXXXXXX
create
registers a new verification service with Twilio, which will allow your application to later send and verify codes to and from that phone number and user.
send()
Once your user reaches the point in your app's login where you would like them to input the sms code:
client.send(*USER_ID*);
Make sure that the user ID or username you pass as an argument is the same as the user ID you passed to
client.create()
send
then routes through Twilio's API and sends an SMS containing the six-digit verification code to the phone number you associated with the user ID when you registered your user when you invoked create
.
verify()
Once your user inputs their six digit code, pass it into the verification method:
client.verify(*USER_ID*, *SIX_DIGIT_CODE*)
Make sure that the code you pass is a
string
! NOT anumber
.
verify
will properly identify and return
true
if the code is valid, false
if the code is invalid.
Sierra Swaby, Ryan Dang, Giuseppe Valentino, Ian Geckeler, & Daniel Nagano-Gerace
FAQs
Implement two-factor SMS authentication with the Twilio API in three lines of code.
The npm package two-auth receives a total of 5 weekly downloads. As such, two-auth popularity was classified as not popular.
We found that two-auth demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.