No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
latch
README.md

README.md

#LATCH INSTALLATION GUIDE FOR SQUIRRELMAIL

##PREREQUISITES

  • SquirrelMail version 1.4.22 or later.

  • Curl extensions active in PHP (uncomment "extension=php_curl.dll" or"** extension=curl.so"** in Windows or Linux php.ini respectively.

  • To get the "Application ID" and "Secret", (fundamental values for integrating Latch in any application), it’s necessary to register a developer account in Latch's website On the upper right side, click on "Developer area".

##DOWNLOADING THE SQUIRRELMAIL PLUGIN

  • When the account is activated, the user will be able to create applications with Latch and access to developer documentation, including existing SDKs and plugins. The user has to access again to Developer area, and browse his applications from "My applications" section in the side menu.

  • When creating an application, two fundamental fields are shown: "Application ID" and "Secret", keep these for later use. There are some additional parameters to be chosen, as the application icon (that will be shown in Latch) and whether the application will support OTP (One Time Password) or not.

  • From the side menu in developers area, the user can access the "Documentation & SDKs" section. Inside it, there is a "SDKs and Plugins" menu. Links to different SDKs in different programming languages and plugins developed so far, are shown.

##INSTALLING THE PLUGIN IN SQUIRRELMAIL

  • Once the administrator has downloaded the plugin, it has to be added to the SquirrelMail plugins directory. Extract the 'latch' folder from the ZIP file and copy it to SQUIRRELMAIL_INSTALLATION_DIR/plugins.

  • To enable the plugin, the file SQUIRRELMAIL_INSTALLATION_DIR/config/config.php has to be edited, adding the string 'latch' to the $plugins array. If there isn't any plugin enabled, the $plugins array will not be defined. In that case, just add the line $plugins[] = 'latch' to the end of the file.

  • Once the plugin is enabled, it is necessary to configure the "Application ID" and "Secret" to contact with the Latch API. To configure this, edit the file located at SQUIRRELMAIL_INSTALLATION_DIR/plugins/latch/latchConfiguration.php, in the $applicationId and $applicationSecret static attributes of the LatchConfiguration class.

##UNINSTALLING THE PLUGIN IN SQUIRRELMAIL

  • To uninstall Latch, just comment out the line added above, this way: //$plugins[] = 'latch'

##USE OF LATCH MODULE FOR THE USERS Latch does not affect in any case or in any way the usual operations with an account. It just allows or denies actions over it, acting as an independent extra layer of security that, once removed or without effect, will have no effect over the accounts, that will remain with its original state.

###Pairing a user in SquirrelMail The user needs the Latch application installed on the phone, and follow these steps:

  • Step 1: Logged in your own account, go to the administration window. “Options” will show a new section named “Latch settings” where the user may add the token generated by its mobile device.

  • Step 2: From the Latch app on the phone, the user has to generate the token, pressing on “Add a new service" at the bottom of the application, and pressing "Generate new code" will take the user to a new screen where the pairing code will be displayed.

  • Step 3: The user has to type the characters generated on the phone into the text box displayed on the web page. Click on "Pair account" button.

  • Step 4: Now the user may lock and unlock the account, preventing any unauthorized access.

###Unpairing a user in SquirrelMail

  • The user should access the administration window of their email account on SquirrelMail. Under the “Options” section under the “Latch settings” tab, tap the “Unpair account” button. He will receive a notification indicating that the service has been unpaired.

##RESOURCES