User Self-Registration Management

Self Registration Processing

---

Initial Understanding Document

• Initial Understanding Document

Overview

MasonSQL framework allows new user to do self-registration by doing request through MasonSQL login page and then system will verify login information and send confirmation email to new user with login credentials for first login.

• MasonSQL administrator user should enable self-registration feature in apache configuration file to allow end user to register to this framework.
• New user can submit basic information to create new account to access this framework.
• User registration is supported for two different types (syslogin and email). Following section will give more detail about user registration types.
• User will be allowed to change password by using "Reset Password" feature.
• New user should confirm his login within predefined time frame. In case user fails to do confirmation, MasonSQL system will remove those users permanently.
• New user registration will be enabled with captcha feature.
• User will be allowed to change password by using "Reset Password" feature.
• User will get SMS alert with initial password in case valid number has provided.

Functional Processing

• New user registration feature can be activated using "UserRegistration" parameter as "enable" or "disable" in apache configuration file.
• User can get self-registration form on login page itself. User can enter basic profile information to create new login.
• System supports two type of registrations today (syslogin & email). Administrator user should set "LoginType" parameter as "syslogin" or "email" to activate desired feature.
  • LoginType = syslogin
    • Show "E-mail" & "Nome utente" both as mandatory fields on GUI registration page.
    • In this scenario, multiple users can be associated with single email id. But only user-id must be unique in any case. Below example shows multiple login with same email can be configured with "syslogin" type.
      • rajmad@yahoo.com : user-01
      • rajmad@yahoo.com : user-02
      • rajmad@yahoo.com : user-03
      • girishkhot@yahoo.com : user-04
      • ramkadam@yahoo.com : user-05
  • LoginType = email
    • Show only "Nome utente" as mandatory fields on GUI registration page."E-mail" is not required in this setting.
    • In this scenario, one user can be associated with single email id. As in this case email id and login id both will be same. Also system will copy same login id internally as user id.
      • rajmad@yahoo.com : rajmad@yahoo.com
      • girishkhot@yahoo.com : girishkhot@yahoo.com
      • samkad@yahoo.com : samkad@yahoo.com

• System will verify user login detail and will send confirmation mail with initial password on given email id. After getting acknowledgement mail, end user has to confirm registration by login into system with predefined time frame. System administrator user can set user confirmation time in days in apache configuration file.

Captcha Setup

MasonSQL framework supports user registration and password reset features to allow end users to do self-registration into system. System supports captcha feature to make sure that end user is real human sending this request and not a robot program. MasonSQL uses open source captcha solution provided by google services. System administrator user must have google account to register your domain and to generate site key and secret keys to use reCaptcha for your domain. Below are easy steps to generate your keys to utilize this feature.

• Generate API Keys
  • Administrator user should use google credentials and login to https://www.google.com/recaptcha/admin to create reCaptcha keys. Google sevices will ask you to register your website, so give it a suitable name, then list domains (for example masonsql-doc2.leader.it) where this particular reCAPTCHA will be used. Subdomains (such as webmaster.masonsql-doc2.leader.it) will be automatically taken into account. Once you register to this site, you will get a "Site key" and "Secret key" as below.You will need both these keys to make captcha validation in MasonSQL.
    '
    
• Configure keys in MasonSQL
  Administrator user should configure "ReCaptchaAPISecretKey" and "ReCaptchaAPISiteKey" parameters in apache configuration file to utilize reCaptcha feature.

User Screens

• Administraor user should set registration feature enabled to allow self-registration. Below are images showing new registration form and login page

System Configuration

This section will give overview of list of configuration parameters required for user registration. Administrator user should configure below parameters in apache configuration file to change the behavior of the system.

{| style="background-color:white;" ! Config Parameter !! Description !! Example |- | UserRegistration | User Registration enable/disable:

• [Enable]: User registration will be enabled
• [Disable]: User registration will be disabled.

Administrator user should set "enable" value to allow end user to register to framework. | PerlSetVar UserRegistration "enable" |- | UserPasswordReset | User Password Reset enable/disable:

• [Enable]: User password reset will be enabled
• [Disable]: User password reset will be disabled.

Administrator user should set "enable" value to allow end user to reset password for given login. | PerlSetVar UserPasswordReset "enable" |- | LoginType | User Registration Type:

• [syslogin]: New user can use same email id and can create multiple unique login id's.
• [email]: Unique id-mail will be used as a login ID

| PerlSetVar LoginType "syslogin" |- | NewUserRegisterGroup | User registration default group name:

• [Guest]: Any new user will be added into "Guest" group.
• [Admins]: Any new user will be added into "Admins" group.

Administrator user should use valid group name for this parameter. | PerlSetVar NewUserRegisterGroup "Guest" |- | UserRegTypeMessage | User registration sms or email notification configuration.

• [email]: End user will get temporary password as email.
• [sms]: End user will get temporary password as sms. "Cell. SMS" field will be mandatory on form.

User will get notification only if correct email or phone number has been provided. | PerlSetVar UserRegTypeMessage"email" |- | PasswordRandPattern | Registered user random password format:

• c - Any lower case Latin [a-z]
• C - Any uppercase Latin [A-Z]
• N - Any digits [0-9]
• . - Any of the above
• S - A character "salt" [A-Za-z0-9./]
• B - Any binary data
• ! - A punctuation character [`~! @ $% ^ & * () -_ + = {} [] \ :;" '. <>? / #,]

| PerlSetVar PasswordRandPattern "Cccsssnn" |- | MaxTimeToConfirmUserRegistration | The maximum time for the new user confirmation in days:

• [days] number of days in digit (ie 7, 15, 30, 60)

| PerlSetVar MaxTimeToConfirmUserRegistration 7 |- | ReCaptchaAPISecretKey | reCaptcha API site key generated for domain.
This key will be used to validate reCaptcha at server side. | nowrap | PerlSetVar ReCaptchaAPISecretKey '6LchdQgUAAAAAL9Ui' |- | ReCaptchaAPISiteKey | reCaptcha API secret key generated for domain.
This key will be used to generate captcha widget at client side. | PerlSetVar ReCaptchaAPISiteKey '6LchdQgUAAAAAK' |- | UserRegOptionalFields | List of active optional fields (fields defined in table public.anagrafiche ).
Available fields:

• cell_sms
• codice_fiscale
• descrizione
• indirizzo
• provincia
• citta
• tele1
• tele2

| PerlSetVar UserRegOptionalFields "descrizione codice_fiscale" |}