├── yalc.lock ├── templates ├── PasswordReset.js ├── ViewHelper.js ├── migration_add_account_status_to_users_schema.js ├── migration_add_password_reset_schema.js ├── SendLink.js ├── authEvents.js ├── Login.js ├── ResetPassword.js ├── InAppResetPassword.js ├── welcome-mail.edge ├── AccountCreation.js ├── apiAuthRoutes.js ├── Handler.js ├── adonis-auth-builder.mustache ├── ApiAuthController.js └── password-mail.edge ├── instructions.js ├── index.js ├── package.json ├── .gitignore ├── providers └── AdonisAuthBuilderProvider.js ├── instructions.md ├── README.md ├── commands └── MakeAuth.js └── LICENSE /yalc.lock: -------------------------------------------------------------------------------- 1 | { 2 | "version": "v1", 3 | "packages": {} 4 | } -------------------------------------------------------------------------------- /templates/PasswordReset.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ 4 | const Model = use('Model') 5 | 6 | class PasswordReset extends Model { 7 | } 8 | 9 | module.exports = PasswordReset 10 | -------------------------------------------------------------------------------- /instructions.js: -------------------------------------------------------------------------------- 1 | /** 2 | * adonis-auth-builder 3 | * 4 | * (c) Emmanuel Ogbiyoyo 5 | * 6 | * For the full copyright and license information, please view the LICENSE 7 | * file that was distributed with this source code. 8 | */ 9 | 10 | module.exports = async (cli) => {}; 11 | -------------------------------------------------------------------------------- /templates/ViewHelper.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | const Config = use("Config"); 3 | 4 | class ViewHelper { 5 | async handle({ view }, next) { 6 | view.share({ 7 | Config: Config 8 | }); 9 | // call next to advance the request 10 | await next(); 11 | } 12 | } 13 | 14 | module.exports = ViewHelper; 15 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const ace = require("@adonisjs/ace"); 2 | ace.command( 3 | "make:auth", 4 | "Generates Views, Controllers and Models for user authentication", 5 | function({ name }) { 6 | console.log(`Scaffolding basic authentication`); 7 | } 8 | ); 9 | 10 | // Boot ace to execute commands 11 | ace.wireUpWithCommander(); 12 | ace.invoke(); 13 | -------------------------------------------------------------------------------- /templates/migration_add_account_status_to_users_schema.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | /** @type {import('@adonisjs/lucid/src/Schema')} */ 4 | const Schema = use("Schema"); 5 | 6 | class AddAccountStatusToUsersSchema extends Schema { 7 | up() { 8 | this.alter("users", (table) => { 9 | table.dateTime("is_activated_at"); 10 | }); 11 | } 12 | 13 | down() { 14 | this.table("users", (table) => { 15 | table.dropColumn("is_activated_at"); 16 | }); 17 | } 18 | } 19 | 20 | module.exports = AddAccountStatusToUsersSchema; 21 | -------------------------------------------------------------------------------- /templates/migration_add_password_reset_schema.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | /** @type {import('@adonisjs/lucid/src/Schema')} */ 4 | const Schema = use('Schema') 5 | 6 | class PasswordResetSchema extends Schema { 7 | up () { 8 | this.create('password_resets', (table) => { 9 | table.increments() 10 | table.integer('user_id') 11 | table.string('token') 12 | table.string('expires_at') 13 | table.timestamps() 14 | }) 15 | } 16 | 17 | down () { 18 | this.drop('password_resets') 19 | } 20 | } 21 | 22 | module.exports = PasswordResetSchema 23 | -------------------------------------------------------------------------------- /templates/SendLink.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | class SendLink { 4 | get validateAll() { 5 | return true; 6 | } 7 | get rules() { 8 | return { 9 | email: "required|email", 10 | }; 11 | } 12 | 13 | get messages() { 14 | return { 15 | "email.required": "Email is required", 16 | "email.email": " Provide a valid email address", 17 | }; 18 | } 19 | 20 | async fails(errorMessages) { 21 | return this.ctx.response.status(400).json({ 22 | status: "invalid", 23 | message: "Invalid data", 24 | status_code: 400, 25 | errorMessages: errorMessages[0].message, 26 | }); 27 | } 28 | } 29 | 30 | module.exports = SendLink; 31 | -------------------------------------------------------------------------------- /templates/authEvents.js: -------------------------------------------------------------------------------- 1 | const Config = use("Config"); 2 | const Event = use("Event"); 3 | const Mail = use("Mail"); 4 | 5 | Event.on("user::created", async (mailDetails) => { 6 | await Mail.send("auth.emails.welcome-mail", mailDetails, (message) => { 7 | message.to(mailDetails.user.email); 8 | message.from("admin@example.com"); 9 | }); 10 | }); 11 | 12 | Event.on("forgot::password", async ({ user, token }) => { 13 | await Mail.send( 14 | "auth.emails.password", 15 | { 16 | token, 17 | user, 18 | appURL: Config.get("adonis-auth-builder.appURL"), 19 | }, 20 | (message) => { 21 | message.to(user.email); 22 | message.from("admin@example.com").subject("Password reset"); 23 | } 24 | ); 25 | }); 26 | -------------------------------------------------------------------------------- /templates/Login.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | class Login { 4 | get validateAll() { 5 | return true; 6 | } 7 | get rules() { 8 | return { 9 | email: "required|email", 10 | password: "required", 11 | }; 12 | } 13 | 14 | get messages() { 15 | return { 16 | "email.required": "Email is required", 17 | "password.required": "Password is required", 18 | "email.email": "Please provide a valid email address", 19 | }; 20 | } 21 | 22 | async fails(errorMessages) { 23 | return this.ctx.response.status(400).json({ 24 | status: "invalid", 25 | message: "Invalid data", 26 | status_code: 400, 27 | errorMessages: errorMessages[0].message, 28 | }); 29 | } 30 | } 31 | 32 | module.exports = Login; 33 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "adonis-auth-builder", 3 | "version": "1.0.3", 4 | "description": "Painless authentication generator for your Adonis.js app available to you in one sexy command.", 5 | "main": "index.js", 6 | "dependencies": { 7 | "adonis-fold": "^3.0.3", 8 | "randomstring": "^1.1.5", 9 | "moment": "^2.24.0" 10 | }, 11 | "devDependencies": { 12 | "@adonisjs/ace": "^6.0.0", 13 | "@adonisjs/fold": "^6.0.3" 14 | }, 15 | "scripts": { 16 | "test": "echo Tests running..." 17 | }, 18 | "keywords": [ 19 | "authentication", 20 | "adonis", 21 | "api", 22 | "full-stack" 23 | ], 24 | "author": "Emmanuel Ogbiyoyo ", 25 | "license": "GPL-3.0", 26 | "repository": "https://github.com/ogbiyoyosky/adonis-auth-builder", 27 | "private": false 28 | } 29 | -------------------------------------------------------------------------------- /templates/ResetPassword.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | class ResetPassword { 4 | get validateAll() { 5 | return true; 6 | } 7 | get rules() { 8 | return { 9 | token: "required", 10 | password: "required", 11 | confirm_password: "required", 12 | }; 13 | } 14 | 15 | get messages() { 16 | return { 17 | "confirm_password.required": "Password is required", 18 | "password.required": "Password is required", 19 | "token.required": " Token is required", 20 | }; 21 | } 22 | 23 | async fails(errorMessages) { 24 | return this.ctx.response.status(400).json({ 25 | status: "invalid", 26 | message: "Invalid data", 27 | status_code: 400, 28 | errorMessages: errorMessages[0].message, 29 | }); 30 | } 31 | } 32 | 33 | module.exports = ResetPassword; 34 | -------------------------------------------------------------------------------- /templates/InAppResetPassword.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | class Login { 4 | get validateAll() { 5 | return true; 6 | } 7 | get rules() { 8 | return { 9 | old_password: "required", 10 | new_password: "required", 11 | confirm_new_password: "required", 12 | }; 13 | } 14 | 15 | get messages() { 16 | return { 17 | "old_password.required": "Old Password is required", 18 | "new_password.required": "New Password is required", 19 | "confirm_new_password.required": "New Password Confirmation is required", 20 | }; 21 | } 22 | 23 | async fails(errorMessages) { 24 | return this.ctx.response.status(400).json({ 25 | status: "invalid", 26 | message: "Invalid data", 27 | status_code: 400, 28 | errorMessages: errorMessages[0].message, 29 | }); 30 | } 31 | } 32 | 33 | module.exports = Login; 34 | -------------------------------------------------------------------------------- /templates/welcome-mail.edge: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |

Successfully created account

8 | 9 |
10 | Thanks for creating an account. 11 |
12 | 13 | 14 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # yalc package cache 24 | .yalc 25 | 26 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 27 | .grunt 28 | 29 | # Bower dependency directory (https://bower.io/) 30 | bower_components 31 | 32 | # node-waf configuration 33 | .lock-wscript 34 | 35 | # Compiled binary addons (https://nodejs.org/api/addons.html) 36 | build/Release 37 | 38 | # Dependency directories 39 | node_modules/ 40 | jspm_packages/ 41 | 42 | # TypeScript v1 declaration files 43 | typings/ 44 | 45 | # Optional npm cache directory 46 | .npm 47 | 48 | # Optional eslint cache 49 | .eslintcache 50 | 51 | # Optional REPL history 52 | .node_repl_history 53 | 54 | # Output of 'npm pack' 55 | *.tgz 56 | 57 | # Yarn Integrity file 58 | .yarn-integrity 59 | 60 | # dotenv environment variables file 61 | .env 62 | 63 | # next.js build output 64 | .next 65 | -------------------------------------------------------------------------------- /providers/AdonisAuthBuilderProvider.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | /** 4 | * adonis-auth-builder 5 | * 6 | * (c) Emmanuel Ogbiyoyo 7 | * 8 | * For the full copyright and license information, please view the LICENSE 9 | * file that was distributed with this source code. 10 | */ 11 | 12 | const { ServiceProvider } = require("@adonisjs/fold"); 13 | 14 | class AdonisAuthBuilderProvider extends ServiceProvider { 15 | /** 16 | * Setup scaffold command for authentications. 17 | * 18 | * @method _setupScaffoldCommand 19 | * 20 | * @return {void} 21 | * 22 | * @private 23 | */ 24 | _setupScaffoldCommand() { 25 | this.app.bind("Adonis/Commands/Make:Auth", (app) => 26 | require("../commands/MakeAuth") 27 | ); 28 | } 29 | 30 | /** 31 | * Registers IOC bindings for this package. 32 | * 33 | * @method register 34 | * 35 | * @return {void} 36 | */ 37 | register() { 38 | this._setupScaffoldCommand(); 39 | } 40 | 41 | /** 42 | * When provider is booted, fold will call this method. 43 | * 44 | * @method boot 45 | * 46 | * @return {void} 47 | */ 48 | boot() { 49 | const ace = require("@adonisjs/ace"); 50 | ace.addCommand("Adonis/Commands/Make:Auth"); 51 | } 52 | } 53 | 54 | module.exports = AdonisAuthBuilderProvider; 55 | -------------------------------------------------------------------------------- /templates/AccountCreation.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | class AccountCreation { 4 | get sanitizationRules() { 5 | return { 6 | email: "trim|normalize_email", 7 | password: "trim", 8 | }; 9 | } 10 | 11 | get rules() { 12 | return { 13 | first_name: "required", 14 | last_name: "required", 15 | email: "required|email|unique:users,email", 16 | password: "required|min:6", 17 | password_confirmation: "required|min:6", 18 | phone_number: "string", 19 | }; 20 | } 21 | 22 | get messages() { 23 | return { 24 | "first_name.required": "First Name is required", 25 | "last_name.required": "Last Name is required", 26 | "email.required": "Email is required", 27 | "email.email": "Email is invalid", 28 | "email.unique": "An account with this Email exists", 29 | "password.required": "Password is required", 30 | "password_confirmation.required": "Password confirmation is required", 31 | "password.min": "Password too short. Expected a minimum of 6 characters", 32 | }; 33 | } 34 | 35 | async fails(errorMessages) { 36 | return this.ctx.response.status(400).json({ 37 | status_code: 400, 38 | status: "Invalid", 39 | description: "Invalid Data", 40 | message: errorMessages[0].message, 41 | }); 42 | } 43 | } 44 | 45 | module.exports = AccountCreation; 46 | -------------------------------------------------------------------------------- /instructions.md: -------------------------------------------------------------------------------- 1 | ## Getting Started with Adonis Auth Builder. 2 | 3 | Thanks for using Adonis auth scaffold. 4 | 5 | ### Register providers. 6 | 7 | The `adonis-auth-builder` provider must be registered as an `aceProvider`. 8 | We are running CLI commands after all! 9 | 10 | ```js 11 | const aceProviders = [ 12 | "adonis-auth-builder/providers/AdonisAuthBuilderProvider", 13 | ]; 14 | ``` 15 | 16 | Also add providers for the newly installed dependencies. 17 | 18 | ```js 19 | const providers = [ 20 | "@adonisjs/validator/providers/ValidatorProvider", 21 | "@adonisjs/mail/providers/MailProvider", 22 | ]; 23 | ``` 24 | 25 | ### Register Middleware 26 | 27 | Register the below middleware in `start/kernel.js` 28 | 29 | ```js 30 | const globalMiddleware = ["App/Middleware/ViewHelper"]; 31 | ``` 32 | 33 | ### Generating auth scaffold. 34 | 35 | Please run the below command to scaffold authentication. 36 | 37 | ```js 38 | adonis make:auth 39 | ``` 40 | 41 | ### Routes 42 | 43 | Please add the following line at the beginning of `start/routes.js`. 44 | 45 | ```js 46 | require("./authRoutes"); 47 | ``` 48 | 49 | ### Events 50 | 51 | Please add the following line at the beginning of `start/events.js`. 52 | 53 | ```js 54 | require("./authEvents"); 55 | ``` 56 | 57 | ### Migrations 58 | 59 | Run the following command to run startup migrations. 60 | Please remember to add the `status` column to your User migration. 61 | 62 | ```js 63 | adonis migration:run 64 | ``` 65 | -------------------------------------------------------------------------------- /templates/apiAuthRoutes.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const Config = use("Config"); 4 | /* 5 | |-------------------------------------------------------------------------- 6 | | API Auth Routes 7 | |-------------------------------------------------------------------------- 8 | | 9 | | Http routes are entry points to your web application. You can create 10 | | routes for different URL's and bind Controller actions to them. 11 | | 12 | | A complete guide on routing is available here. 13 | | http://adonisjs.com/docs/4.1/routing 14 | | 15 | */ 16 | 17 | /** @type {typeof import('@adonisjs/framework/src/Route/Manager')} */ 18 | const Route = use("Route"); 19 | 20 | Route.group(() => { 21 | Route.post("/login", "ApiAuthController.login").validator("Login"); 22 | Route.post("/register", "ApiAuthController.register").validator( 23 | "AccountCreation" 24 | ); 25 | Route.get( 26 | "/account/confirm/:confirmation_token", 27 | "ApiAuthController.confirmUserAccount" 28 | ); 29 | Route.post(`/forgot-password`, "ApiAuthController.forgotPassword").validator( 30 | "SendLink" 31 | ); 32 | Route.post(`/reset-password`, "ApiAuthController.resetPassword").validator( 33 | "ResetPassword" 34 | ); 35 | Route.post(`/generate-token`, "ApiAuthController.generateToken"); 36 | Route.post(`/reset-password-in-app`, "ApiAuthController.resetPasswordInApp") 37 | .middleware("auth") 38 | .validator("InAppResetPassword"); 39 | Route.get(`/logout`, "ApiAuthController.logout"); 40 | }).prefix("/v1"); 41 | -------------------------------------------------------------------------------- /templates/Handler.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | const BaseExceptionHandler = use('BaseExceptionHandler') 4 | 5 | /** 6 | * This class handles all exceptions thrown during 7 | * the HTTP request lifecycle. 8 | * 9 | * @class ExceptionHandler 10 | */ 11 | class ExceptionHandler extends BaseExceptionHandler { 12 | /** 13 | * Handle exception thrown during the HTTP lifecycle 14 | * 15 | * @method handle 16 | * 17 | * @param {Object} error 18 | * @param {Object} options.request 19 | * @param {Object} options.response 20 | * 21 | * @return {void} 22 | */ 23 | async handle (error, { request, response }) { 24 | console.log(error) 25 | if(error.name === 'InvalidJwtToken') { 26 | return response.status(401).send({ 27 | message:"Please provide a valid token", 28 | status_code: 401, 29 | status: 'InvalidToken' 30 | }) 31 | } 32 | 33 | if(error.name === 'ExpiredJwtToken') { 34 | return response.status(401).send({ 35 | message:"Expired Access token", 36 | status_code: 401, 37 | status: 'Expired JWT' 38 | }) 39 | } 40 | 41 | 42 | 43 | } 44 | 45 | /** 46 | * Report exception for logging or debugging. 47 | * 48 | * @method report 49 | * 50 | * @param {Object} error 51 | * @param {Object} options.request 52 | * 53 | * @return {void} 54 | */ 55 | async report (error, { request }) { 56 | } 57 | } 58 | 59 | module.exports = ExceptionHandler 60 | -------------------------------------------------------------------------------- /templates/adonis-auth-builder.mustache: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const Env = use('Env'); 4 | 5 | /* 6 | |-------------------------------------------------------------------------- 7 | | Adonis Auth Builder 8 | |-------------------------------------------------------------------------- 9 | | 10 | | Adonis Auth Builder is a CLI utility that gives you a functional authentication 11 | | system in Adonis.js within seconds. 12 | | 13 | */ 14 | 15 | module.exports = { 16 | /* 17 | |-------------------------------------------------------------------------- 18 | | Registration Route 19 | |-------------------------------------------------------------------------- 20 | | 21 | | Specifies the route to handle registration GET and POST requests. 22 | | 23 | */ 24 | registrationRoute: "/register", 25 | 26 | /* 27 | |-------------------------------------------------------------------------- 28 | | Registration Success Redirect Route 29 | |-------------------------------------------------------------------------- 30 | | 31 | | Specifies the route to redirect the user to upon successful registration. 32 | | Leave empty if you do not want any redirects. 33 | | 34 | */ 35 | registrationSuccessRedirectTo: "/auth/dashboard", 36 | 37 | /* 38 | |-------------------------------------------------------------------------- 39 | | Login Route 40 | |-------------------------------------------------------------------------- 41 | | 42 | | Specifies the route to handle login GET and POST requests. 43 | | 44 | */ 45 | loginRoute: "/login", 46 | 47 | /* 48 | |-------------------------------------------------------------------------- 49 | | Password Reset Route 50 | |-------------------------------------------------------------------------- 51 | | 52 | | Specifies the route to handle password reset GET and POST requests. 53 | | 54 | */ 55 | passwordResetRoute: "/password/reset", 56 | 57 | /* 58 | |-------------------------------------------------------------------------- 59 | | Logout Route 60 | |-------------------------------------------------------------------------- 61 | | 62 | | Specifies the route to handle logout GET and POST requests. 63 | | 64 | */ 65 | logoutRoute: "/logout", 66 | 67 | /* 68 | |-------------------------------------------------------------------------- 69 | | App URL 70 | |-------------------------------------------------------------------------- 71 | | 72 | | Specifies the URL for the app. 73 | | 74 | */ 75 | appURL: "http://localhost:8081", 76 | 77 | 78 | }; 79 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Adonis Auth Builder Logo](https://i.ibb.co/mJt9gh1/Whats-App-Image-2020-08-14-at-08-20-58.jpg) 2 | 3 | # Adonis Auth Builder. 4 | 5 | Adonis auth scaffold offers you painless authentication 6 | 7 | Spend those minutes you'd use in setting up authentication doing awesome stuff within your app. 8 | 9 | ## Index 10 | 11 | - [Introduction](#introduction) 12 | - [Installation](#installation) 13 | - [Getting Started](#getting-started) 14 | 15 | ## Introduction 16 | 17 | ### Directory Structure 18 | 19 | ``` 20 | app 21 | └── Controllers 22 | └── HTTP 23 | ├── AuthController.js 24 | ├── ApiAuthController.js 25 | config 26 | ├── adonis-auth-builder.js 27 | resources 28 | └── views 29 | └── auth 30 | └── emails 31 | ├── password.edge 32 | ├── welcome-mail.edge 33 | 34 | start 35 | ├── authEvents.js 36 | ├── authRoutes.js 37 | ├── apiAuthRoutes.js 38 | ``` 39 | 40 | ## About Adonis Auth Builder. 41 | 42 | Adonis Auth Scaffold is a CLI utility that gives you a functional authentication system in Adonis.js 43 | within seconds. 44 | 45 | ## Getting Started 46 | 47 | ### Installation 48 | 49 | Install `adonis-auth-builder` by running the below command. 50 | 51 | **NPM** 52 | 53 | ```bash 54 | npm install adonis-auth-builder --save-dev 55 | npm install @adonisjs/mail @adonisjs/validator 56 | ``` 57 | 58 | **Yarn** 59 | 60 | ```bash 61 | yarn add adonis-auth-builder --save-dev 62 | yarn add @adonisjs/mail @adonisjs/validator 63 | ``` 64 | 65 | ### Register providers. 66 | 67 | The `adonis-auth-builder` provider must be registered as an `aceProvider`. 68 | We are running CLI commands after all! 69 | 70 | ```js 71 | const aceProviders = [ 72 | "adonis-auth-builder/providers/AdonisAuthBuilderProvider", 73 | ]; 74 | ``` 75 | 76 | Also add providers for the newly installed dependencies. 77 | 78 | ```js 79 | const providers = [ 80 | "@adonisjs/validator/providers/ValidatorProvider", 81 | "@adonisjs/mail/providers/MailProvider", 82 | ]; 83 | ``` 84 | 85 | ### Generating auth scaffold. 86 | 87 | ![Auth Scaffold Gif](https://user-images.githubusercontent.com/5021686/54365412-10485200-466f-11e9-8fb5-cbaa920c6950.gif) 88 | 89 | Please run the below command to scaffold authentication. 90 | 91 | ```js 92 | adonis make:auth 93 | ``` 94 | 95 | A prompt to choose between generating code for a RESTful Api or a HTTP client allows you customize the generated files for your specific use case. 96 | Alternative versions of this command involves passing either the `--api-only` or `--http-only` flags. 97 | 98 | To generate auth files for a REST Api, you may run: 99 | 100 | ```js 101 | adonis make:auth --api-only 102 | ``` 103 | 104 | ### Events 105 | 106 | Please add the following line at the beginning of `start/events.js`. 107 | 108 | ```js 109 | require("./authEvents"); 110 | ``` 111 | 112 | ### Migrations 113 | 114 | Run the following command to run startup migrations. 115 | Please remember to add the `status` column to your User migration. 116 | 117 | ```js 118 | adonis migration:run 119 | ``` 120 | 121 | ## Author 122 | 123 | Emmanuel Ogbiyoyo 124 | 125 | ## Contributing 126 | 127 | Contributions are welcome! Check out the [issues](https://github.com/ogbiyoyosky/adonis-auth-builder/issues) or the [PRs](https://github.com/ogbiyoyosky/adonis-auth-builder/pull-requests), and make your own if you want something that you don't see there. 128 | 129 | ## License 130 | 131 | [GPLv3.0](https://github.com/ogbiyoyosky/adonis-auth-builder) 132 | -------------------------------------------------------------------------------- /commands/MakeAuth.js: -------------------------------------------------------------------------------- 1 | /** 2 | * adonis-auth-builder 3 | * 4 | * (c) Emmanuel Ogbiyoyo 5 | * 6 | * For the full copyright and license information, please view the LICENSE 7 | * file that was distributed with this source code. 8 | */ 9 | 10 | const _ = require("lodash"); 11 | const path = require("path"); 12 | const packageNamespace = "adonis-auth-builder"; 13 | 14 | const Helpers = use("Helpers"); 15 | 16 | const { Command } = require("@adonisjs/ace"); 17 | 18 | class MakeAuth extends Command { 19 | /* istanbul ignore next */ 20 | /** 21 | * The command signature. 22 | * 23 | * @method signature 24 | * 25 | * @return {String} 26 | */ 27 | /* istanbul ignore next */ 28 | static get signature() { 29 | return ` 30 | make:auth 31 | { --api-only : Generates files for RESTful Apis. } 32 | { --http-only : Generates files for HTTP client request. } 33 | 34 | `; 35 | } 36 | 37 | /* istanbul ignore next */ 38 | /** 39 | * The command description. 40 | * 41 | * @method description 42 | * 43 | * @return {String} 44 | */ 45 | static get description() { 46 | return "Generates the auth scaffold."; 47 | } 48 | 49 | /** 50 | * Ensures the command is executed within the project root. 51 | * 52 | * @method ensureInProjectRoot 53 | * 54 | * @return {void} 55 | * 56 | * @private 57 | */ 58 | async _ensureInProjectRoot() { 59 | const acePath = path.join(process.cwd(), "ace"); 60 | const exists = await this.pathExists(acePath); 61 | 62 | if (!exists) { 63 | throw new Error( 64 | "Oops! Make sure you are inside an Adonisjs app to run the make:auth command." 65 | ); 66 | } 67 | } 68 | 69 | /** 70 | * Creates the ApiAuthController.js file for the HTTP client. 71 | * 72 | * @returns {Void} 73 | */ 74 | copyApiAuthController() { 75 | try { 76 | this.copy( 77 | path.join(__dirname, "../templates", "ApiAuthController.js"), 78 | path.join( 79 | Helpers.appRoot(), 80 | "app/Controllers/Http/ApiAuthController.js" 81 | ) 82 | ); 83 | this.success("Created Controllers/Http/ApiAuthController.js"); 84 | } catch (error) { 85 | // Output error to console. 86 | this.error(error); 87 | } 88 | } 89 | 90 | /** 91 | * Copy exceptions 92 | * 93 | * @returns {Void} 94 | */ 95 | copyException() { 96 | try { 97 | this.copy( 98 | path.join(__dirname, "../templates", "Handler.js"), 99 | path.join(Helpers.appRoot(), "app/Exceptions/Handler.js") 100 | ); 101 | this.success("Created /Exceptions/Handler.js"); 102 | } catch (error) { 103 | // Output error to console. 104 | this.error(error); 105 | } 106 | } 107 | 108 | copyModel() { 109 | try { 110 | this.copy( 111 | path.join(__dirname, "../templates", "PasswordReset.js"), 112 | path.join(Helpers.appRoot(), "app/Models/PasswordReset.js") 113 | ); 114 | this.success("Created /Models/PasswordReset.js"); 115 | } catch (error) { 116 | // Output error to console. 117 | this.error(error); 118 | } 119 | } 120 | 121 | copyValidators() { 122 | try { 123 | this.copy( 124 | path.join(__dirname, "../templates", "AccountCreation.js"), 125 | path.join(Helpers.appRoot(), "app/Validators/AccountCreation.js") 126 | ); 127 | 128 | this.copy( 129 | path.join(__dirname, "../templates", "InAppResetPassword.js"), 130 | path.join(Helpers.appRoot(), "app/Validators/InAppResetPassword.js") 131 | ); 132 | 133 | this.copy( 134 | path.join(__dirname, "../templates", "Login.js"), 135 | path.join(Helpers.appRoot(), "app/Validators/Login.js") 136 | ); 137 | 138 | this.copy( 139 | path.join(__dirname, "../templates", "ResetPassword.js"), 140 | path.join(Helpers.appRoot(), "app/Validators/ResetPassword.js") 141 | ); 142 | 143 | this.copy( 144 | path.join(__dirname, "../templates", "SendLink.js"), 145 | path.join(Helpers.appRoot(), "app/Validators/SendLink.js") 146 | ); 147 | 148 | this.success("Created /Validators/AccountCreation.js"); 149 | this.success("Created /Validators/InAppResetPassword.js"); 150 | this.success("Created /Validators/Login.js"); 151 | this.success("Created /Validators/ResetPassword.js"); 152 | this.success("Created /Validators/SendLink.js"); 153 | } catch (error) { 154 | // Output error to console. 155 | this.error(error); 156 | } 157 | } 158 | 159 | /** 160 | * Creates the adonis-auth-builder.js config file. 161 | * 162 | * @returns {Void} 163 | */ 164 | async copyConfig() { 165 | try { 166 | await this.copy( 167 | path.join(__dirname, "../templates", `${packageNamespace}.mustache`), 168 | path.join(Helpers.configPath(), `${packageNamespace}.js`) 169 | ); 170 | this.success(`Created config/${packageNamespace}.js`); 171 | } catch (error) { 172 | // Output error to console. 173 | this.error(error); 174 | } 175 | } 176 | 177 | /** 178 | * Creates the email view templates files. 179 | * 180 | * @returns {Void} 181 | */ 182 | async copyEmailViewTemplates() { 183 | try { 184 | await this.copy( 185 | path.join(__dirname, "../templates", "password-mail.edge"), 186 | path.join(Helpers.viewsPath(), "auth/emails/password.edge") 187 | ); 188 | await this.copy( 189 | path.join(__dirname, "../templates", "welcome-mail.edge"), 190 | path.join(Helpers.viewsPath(), "auth/emails/welcome-mail.edge") 191 | ); 192 | 193 | this.success("Created resources/views/auth/emails/password.edge"); 194 | this.success("Created resources/views/auth/emails/welcome-mail.edge"); 195 | } catch (error) { 196 | // Output error to console. 197 | this.error(error); 198 | } 199 | } 200 | 201 | /** 202 | * Creates the app starter files available at app/start. 203 | * 204 | * @param {String} client 205 | * @returns {Void} 206 | */ 207 | async copyAppStarterFiles(client) { 208 | try { 209 | if (client === "http") { 210 | await this.copy( 211 | path.join(__dirname, "../templates", "authRoutes.js"), 212 | path.join(Helpers.appRoot(), "start/authRoutes.js") 213 | ); 214 | } else { 215 | await this.copy( 216 | path.join(__dirname, "../templates", "apiAuthRoutes.js"), 217 | path.join(Helpers.appRoot(), "start/apiAuthRoutes.js") 218 | ); 219 | } 220 | 221 | await this.copy( 222 | path.join(__dirname, "../templates", "authEvents.js"), 223 | path.join(Helpers.appRoot(), "start/authEvents.js") 224 | ); 225 | 226 | const authRoutesSuccessMessage = 227 | client === "http" 228 | ? "Created start/authRoutes.js" 229 | : "Created start/apiAuthRoutes.js"; 230 | 231 | this.success(authRoutesSuccessMessage); 232 | this.success("Created start/authEvents.js"); 233 | } catch (error) { 234 | // Output error to console. 235 | this.error(error); 236 | } 237 | } 238 | 239 | /** 240 | * Creates a migration for users table. 241 | * 242 | * @returns {Void} 243 | */ 244 | async copyMigrationFiles() { 245 | try { 246 | const timestamp = new Date().getTime(); 247 | const newFileNameUser = `database/migrations/${timestamp}_add_account_status_to_users_schema.js`; 248 | const newFileNameReset = `database/migrations/${timestamp}_add_password_reset_schema.js`; 249 | await this.copy( 250 | path.join( 251 | __dirname, 252 | "../templates", 253 | "migration_add_account_status_to_users_schema.js" 254 | ), 255 | path.join(Helpers.appRoot(), newFileNameUser) 256 | ); 257 | 258 | await this.copy( 259 | path.join( 260 | __dirname, 261 | "../templates", 262 | "migration_add_password_reset_schema.js" 263 | ), 264 | path.join(Helpers.appRoot(), newFileNameReset) 265 | ); 266 | this.success(`Created ${newFileNameUser}`); 267 | this.success(`Created ${newFileNameReset}`); 268 | } catch (error) { 269 | this.error(error); 270 | } 271 | } 272 | 273 | /** 274 | * Creates all scaffold templates. 275 | * 276 | * @param {String} client - Specifies if we are generating for an API or HTTP client. 277 | * @param {String} style - Specifies if we are using regular or Bootstrap views. 278 | * @returns {Void} 279 | */ 280 | async _copyFiles(client, style) { 281 | if (client === "http") { 282 | throw new Error("Oops! Http generator not available for this version"); 283 | } else { 284 | await this.copyApiAuthController(); 285 | } 286 | 287 | await this.copyConfig(); 288 | await this.copyEmailViewTemplates(); 289 | await this.copyAppStarterFiles(client); 290 | await this.copyMigrationFiles(); 291 | await this.copyException(); 292 | await this.copyValidators(); 293 | await this.copyModel(); 294 | } 295 | 296 | /** 297 | * Prepends a line of text to a provided file. 298 | * 299 | * @param {String} Object.filename - Fully qualified path of the file to be operated on. 300 | * @param {Number} Object.lineNumber - Line to operate on. 301 | * @param {String} Object.lineContent - Content to be prepended. 302 | * @param {String} Object.afterContent - Finds a line with the content specified and adds the new line after it. 303 | * 304 | * @return {Void} 305 | */ 306 | async _prependLineToFile({ 307 | filename, 308 | lineNumber, 309 | lineContent, 310 | afterContent, 311 | }) { 312 | let fileContents = await this.readFile(filename, "utf-8"); 313 | fileContents = fileContents.split("\n"); 314 | 315 | if (afterContent) { 316 | const i = fileContents.findIndex((l) => l.includes(afterContent)); 317 | if (i > 0) lineNumber = i + 1; 318 | } 319 | 320 | if (fileContents[lineNumber] === lineContent) return; 321 | 322 | fileContents.splice(lineNumber, 0, `\n${lineContent}\n`); 323 | 324 | await this.writeFile(filename, fileContents.join("\n")); 325 | } 326 | 327 | /** 328 | * Method executed by ace when command is called. It 329 | * will create a new sample test for the user. 330 | * 331 | * @method handle 332 | * 333 | * @return {void} 334 | */ 335 | async handle({}, { apiOnly, httpOnly, bootstrap }) { 336 | let client; 337 | let style; 338 | 339 | if (!apiOnly && !httpOnly) { 340 | client = await this.choice( 341 | "Will this be used for a REST Api or for a HTTP Client?", 342 | [ 343 | { 344 | name: "For REST Api", 345 | value: "api", 346 | }, 347 | { 348 | name: "For HTTP", 349 | value: "http", 350 | }, 351 | ] 352 | ); 353 | } else { 354 | client = apiOnly ? "api" : "http"; 355 | } 356 | 357 | if (client == "api") { 358 | try { 359 | // Write a module require statement to the routes.js file. 360 | let routesFilePath = path.join(Helpers.appRoot(), "start/routes.js"); 361 | let generatedRoutesFilename = "apiAuthRoutes.js"; 362 | 363 | await this._prependLineToFile({ 364 | filename: routesFilePath, 365 | lineNumber: 2, 366 | lineContent: `require('./${generatedRoutesFilename}');`, 367 | }); 368 | 369 | let tokenModelFilePath = path.join( 370 | Helpers.appRoot(), 371 | "app/Models/Token.js" 372 | ); 373 | 374 | let tokenModelContent = ` user () { 375 | return this.belongsTo('App/Models/User') 376 | }`; 377 | 378 | await this._prependLineToFile({ 379 | filename: tokenModelFilePath, 380 | afterContent: "class Token", 381 | lineContent: tokenModelContent, 382 | }); 383 | 384 | await this._ensureInProjectRoot(); 385 | await this._copyFiles(client, style); 386 | } catch (error) { 387 | /** 388 | * Throw error if command executed programatically 389 | */ 390 | if (!this.viaAce) { 391 | throw error; 392 | } 393 | this.error(error.message); 394 | } 395 | } 396 | 397 | if (client == "http") { 398 | throw new Error("Oops! htt not avialable for this version."); 399 | } 400 | } 401 | } 402 | 403 | module.exports = MakeAuth; 404 | -------------------------------------------------------------------------------- /templates/ApiAuthController.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | const Config = use("Config"); 3 | const User = use("App/Models/User"); 4 | const Hash = use("Hash"); 5 | const Token = use("App/Models/Token"); 6 | const PasswordReset = use("App/Models/PasswordReset"); 7 | const moment = require("moment"); 8 | const randomString = require("randomstring"); 9 | const Event = use("Event"); 10 | 11 | class ApiAuthController { 12 | async login({ request, auth, response }) { 13 | try { 14 | const { email, password } = request.all(); 15 | const user = await User.query().where("email", email).first(); 16 | 17 | if (!user) { 18 | return response.status(400).send({ 19 | message: "email does not exist", 20 | status_code: 400, 21 | status: "fail", 22 | }); 23 | } 24 | 25 | const token = await auth.withRefreshToken().attempt(email, password); 26 | const authConfig = Config.get("auth"); 27 | const { expiresIn } = authConfig.jwt.options; 28 | token.expiresIn = expiresIn; 29 | 30 | return response.status(200).send({ 31 | message: "Login Successful", 32 | status: "Success", 33 | status_code: 200, 34 | result: token, 35 | }); 36 | } catch (error) { 37 | console.log("Login Error -> ", error); 38 | return response.status(400).send({ 39 | status: "fail", 40 | status_code: 400, 41 | message: "Email Or Password Incorrect", 42 | }); 43 | } 44 | } 45 | 46 | async register({ request, auth, response }) { 47 | try { 48 | let payload = request.only([ 49 | "email", 50 | "first_name", 51 | "last_name", 52 | "phone_number", 53 | "password", 54 | ]); 55 | 56 | const { password_confirmation } = request.all(); 57 | 58 | const confirmation_token = randomString.generate({ 59 | length: 15, 60 | }); 61 | 62 | if (payload.password !== password_confirmation) { 63 | return response.status(400).send({ 64 | status: "invalid", 65 | message: "Password must match confirmation password", 66 | status_code: 400, 67 | }); 68 | } 69 | const user = await User.create(payload); 70 | const token = await auth 71 | .withRefreshToken() 72 | .attempt(payload.email, payload.password); 73 | 74 | const authConfig = Config.get("auth"); 75 | const frontend = Config.get("adonis-auth-builder"); 76 | 77 | const { expiresIn } = authConfig.jwt.options; 78 | token.expiresIn = expiresIn; 79 | 80 | const mailDetails = { 81 | user, 82 | confirmation_token, 83 | appURL: frontend.appURL, 84 | }; 85 | 86 | await Token.create({ 87 | user_id: user.id, 88 | token: confirmation_token, 89 | type: "confirmation_token", 90 | }); 91 | 92 | Event.fire("user::created", mailDetails); 93 | 94 | return response.status(201).send({ 95 | status: "Success", 96 | message: "Successfully Registered", 97 | status_code: 201, 98 | results: { 99 | user, 100 | token, 101 | }, 102 | }); 103 | } catch (error) { 104 | console.log(error); 105 | return response.status(500).send({ 106 | status: "Fail", 107 | message: "Internal Server Error", 108 | status_code: 500, 109 | }); 110 | } 111 | } 112 | 113 | async confirmUserAccount({ 114 | request, 115 | response, 116 | params: { confirmation_token }, 117 | }) { 118 | try { 119 | if (!confirmation_token) { 120 | return response.status(400).send({ 121 | message: "confirmation_token is required", 122 | status_code: 400, 123 | status: "Invalid Data", 124 | }); 125 | } 126 | const token = await Token.query() 127 | .where({ 128 | type: "confirmation_token", 129 | token: confirmation_token, 130 | is_revoked: 0, 131 | }) 132 | .first(); 133 | 134 | if (!token) 135 | return response.status(400).send({ 136 | message: "User not found or has already confirmed their email", 137 | status_code: 400, 138 | status: "Fail", 139 | }); 140 | 141 | const user = await User.findBy("id", token.user_id); 142 | user.is_activated_at = moment().format("YYYY-MM-DD HH:mm:ss"); 143 | await user.save(); 144 | 145 | await token.delete(); 146 | 147 | return response.status(200).send({ 148 | message: "Account successfully confirmed", 149 | status_code: 200, 150 | status: "Success", 151 | result: user, 152 | }); 153 | } catch (confirmAccountError) { 154 | console.log("confirmAccountError", confirmAccountError); 155 | return response.status(500).send({ 156 | status: "Fail", 157 | message: "Internal Server Error", 158 | status_code: 500, 159 | }); 160 | } 161 | } 162 | 163 | async logout({ request, response, auth }) { 164 | try { 165 | const refreshToken = request.input("refreshToken"); 166 | if (!refreshToken) { 167 | // You can throw any exception you want here 168 | return response.status(400).send({ 169 | status: 400, 170 | status_code: 400, 171 | message: "please provide your refresh token", 172 | }); 173 | } 174 | await auth.authenticator("jwt").revokeTokens([refreshToken], true); 175 | 176 | return response.status(200).send({ 177 | status: 200, 178 | status_code: 200, 179 | message: "Successfully logged", 180 | }); 181 | } catch (logoutError) { 182 | console.log("logoutError", logoutError); 183 | return response.status(500).send({ 184 | status: "Fail", 185 | message: "Internal Server Error", 186 | status_code: 500, 187 | }); 188 | } 189 | } 190 | 191 | async resetPasswordInApp({ request, response, auth }) { 192 | try { 193 | const userObject = await auth.current.user; 194 | const user = await User.findBy("id", userObject.id); 195 | 196 | const { 197 | old_password, 198 | new_password, 199 | confirm_new_password, 200 | } = await request.post(); 201 | 202 | const verifiedPassword = await Hash.verify(old_password, user.password); 203 | 204 | if (!verifiedPassword) { 205 | return response.status(400).send({ 206 | status: "Invalid", 207 | message: "Current Password Could Not Be Verified", 208 | status_code: 400, 209 | }); 210 | } 211 | 212 | if (old_password === new_password) { 213 | return response.status(200).send({ 214 | status: "Success", 215 | message: "Current Password Matches New Password", 216 | status_code: 200, 217 | }); 218 | } 219 | 220 | if (new_password === confirm_new_password) { 221 | user.password = new_password; 222 | await user.save(); 223 | 224 | return response.status(200).send({ 225 | status: "Success", 226 | message: "Password Updated", 227 | status_code: 200, 228 | }); 229 | } else { 230 | return response.status(400).json({ 231 | status: "Bad Request", 232 | message: "Password Change Failed", 233 | status_code: 400, 234 | }); 235 | } 236 | } catch (resetPassword) { 237 | console.log("Reset Password Error =>", resetPassword); 238 | response.status(500).json({ 239 | status: "Internal Server Error", 240 | message: "Internal Error, Please try again later", 241 | status_code: 500, 242 | }); 243 | } 244 | } 245 | 246 | async forgotPassword({ response, request }) { 247 | try { 248 | const { email } = request.all(); 249 | const current_date = Date.now(); 250 | const user = await User.findBy("email", email); 251 | if (user) { 252 | //there is a token that has not expired dont send a mail 253 | const password_reset_token = await Token.query() 254 | .where("user_id", user.id) 255 | .andWhere("type", "password_reset_token") 256 | .andWhere("is_revoked", 0) 257 | .andWhere("created_at", ">", current_date) 258 | .first(); 259 | 260 | if (password_reset_token) { 261 | return response.status(200).send({ 262 | status: "Success", 263 | message: `An email has already been sent to ${user.email} `, 264 | status_code: 200, 265 | }); 266 | } else { 267 | const token = randomString.generate(32); 268 | const expires_at = moment() + 3600000; 269 | // find the last password reset token and delete 270 | const last_token = await PasswordReset.findBy("user_id", user.id); 271 | if (last_token) { 272 | last_token.expires_at = expires_at; 273 | last_token.token = token; 274 | await last_token.save(); 275 | } else { 276 | const password_reset = new PasswordReset(); 277 | password_reset.expires_at = expires_at; 278 | password_reset.token = token; 279 | password_reset.user_id = user.id; 280 | await password_reset.save(); 281 | } 282 | const frontend = Config.get("adonis-auth-builder"); 283 | 284 | const mailDetails = { 285 | user, 286 | token, 287 | appURL: frontend.appURL, 288 | }; 289 | 290 | Event.fire("forgot::password", mailDetails); 291 | } 292 | 293 | return response.status(200).send({ 294 | status: "Success", 295 | message: `A reset mail has been sent to ${user.email}`, 296 | status_code: 200, 297 | }); 298 | } 299 | 300 | return response.status(400).send({ 301 | status: "Fail", 302 | message: "User does not exist in the system", 303 | status_code: 400, 304 | }); 305 | } catch (forgotPassword) { 306 | console.log("forgotPassword", forgotPassword); 307 | return response.status(500).send({ 308 | status: "Fail", 309 | message: "Internal Server Error", 310 | status_code: 500, 311 | }); 312 | } 313 | } 314 | 315 | async resetPassword({ request, response }) { 316 | try { 317 | const { token, password, confirm_password } = request.all(); 318 | 319 | if (password === confirm_password) { 320 | return response.status(400).send({ 321 | status: "fail", 322 | message: "Password do not match", 323 | status_code: 400, 324 | }); 325 | } 326 | const current_date = Date.now(); 327 | //there is a token that has not expired dont send a mail 328 | const password_reset_token = await PasswordReset.query() 329 | .where("token", token) 330 | .andWhere("expires_at", ">", current_date) 331 | .first(); 332 | 333 | if (password_reset_token) { 334 | const user = await User.findBy("id", password_reset_token.user_id); 335 | user.password = password; 336 | await user.save(); 337 | await password_reset_token.delete(); 338 | 339 | return response.status(200).send({ 340 | status: "Success", 341 | message: `Password changed successfully`, 342 | status_code: 200, 343 | }); 344 | } else { 345 | return response.status(400).send({ 346 | status: "Fail", 347 | message: `The password reset token does not exist or has expired.`, 348 | status_code: 400, 349 | }); 350 | } 351 | } catch (forgotPassword) { 352 | console.log("forgotPassword", forgotPassword); 353 | return response.status(500).send({ 354 | status: "Fail", 355 | message: "Internal Server Error", 356 | status_code: 500, 357 | }); 358 | } 359 | } 360 | 361 | async generateToken({ auth, response, request }) { 362 | try { 363 | const { refresh_token } = request.all(); 364 | 365 | if (!refresh_token) { 366 | return response.status(400).send({ 367 | status: "Invalid Data", 368 | message: "refresh_token is required", 369 | status_code: 400, 370 | }); 371 | } 372 | const token = await auth.generateForRefreshToken(refresh_token, true); 373 | return response.status(200).send({ 374 | status: "success", 375 | message: "Token Refreshed", 376 | status_code: 200, 377 | result: token, 378 | }); 379 | } catch (generateTokenError) { 380 | console.log("generateTokenErrror", generateTokenError); 381 | if (generateTokenError.name === "InvalidRefreshToken") { 382 | return response.status(401).send({ 383 | status_code: 401, 384 | status: "InvalidRefreshToken", 385 | message: "Invalid refresh token please login", 386 | }); 387 | } 388 | return response.status(500).send({ 389 | status: "Fail", 390 | message: "Internal Server Error", 391 | status_code: 500, 392 | }); 393 | } 394 | } 395 | } 396 | 397 | module.exports = ApiAuthController; 398 | -------------------------------------------------------------------------------- /templates/password-mail.edge: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 13 | 14 | 15 | 16 | Reset password 17 | 18 | 388 | 389 | 390 |
391 | 392 | 393 | 476 | 477 |
394 | 395 | 400 | 401 | 402 | 403 | 404 | 405 | 420 | 421 | 422 | 464 | 465 | 466 | 467 | 468 |
406 | 407 | 408 | 417 | 418 | 419 |
409 | 410 | 411 | 414 | 415 |
412 | 413 |
416 |
423 | 424 | 425 | 461 | 462 | 463 |
426 | 430 | 431 | 434 | 435 | 436 | 450 | 451 |
437 |

Hello,
438 |
439 | To change your password, please click on the following link :
440 | 441 | 442 | {{ appURL }}/password/reset?token={{ token }} 443 | 444 | 445 |

446 | If you did not make this request, please ignore this message. 447 |

448 | 449 |
452 | 455 | 456 | 460 |
469 | 474 | 475 |
478 |
479 | 480 | 481 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------