#Twofactor

A gem to integrate your Rails app with Google 2Factor-authenticator mobile apps.

Unlike other 2-step auth gems out there, Twofactor does not really require devise. Instead, it creates an endpoint at your command and operates from there.

All you have to do is to make your user register for Twofactor using that endpoint. Get a 2-Factor code from him each time he logs in & call the gem's validator to check if the code is valid.

• Add the following to your application's Gemfile.

gem 'twofactor'

• Do this :

bundle install

• Install twofactor gem.

rails generate twofactor:install <Model> <ReferenceField> <TemplateType> <ControllerName> <TableName>

• Run migrate :

rake db:migrate

• To validate a 2-Factor code on user login, call :

Twofactor::TwoStep.valid_code? <ModelObject>, <Code>

For instance, if you have a @user object who's trying to login, get a 2-Factor code from him if he passes your site's usual login and call the following to validate his 2-Factor :

Twofactor::TwoStep.valid_code? @user, 237654

The method returns true if the code's valid .

If you wish to create your own endpoint & views, use the below two methods to enable & disable Twofactor for an object :

Twofactor::TwoStep.enable_twofactor_auth <ModelObject>

Twofactor::TwoStep.disable_twofactor_auth <ModelObject>

Other Twofactor configurations can be customized in twofactor_config.rb under config/initializers that you'll get on twofactor:install

##Install Generator arguments

Twofactor's install generator accepts five arguments of which the first 3 are mandatory:

• Model - The name of the model to which 2-Step auth needs to be given.

• ReferenceField - Reference field that needs to be used(This field will appear in the client's Google Authenticator app. Defaults to 'email')

• TemplateType - Templating language to use for twofactor_register endpoint's default page (takes one of erb / haml / slim)

• ControllerName - Controller that needs to be configured with TwoFactor actions( Defaults to Controller with Model's name pluralized )

• TableName - Table name corresponding to the model. ( Defaults to Rails's choice of Model )