├── .gitattributes ├── .babelrc ├── .travis.yml ├── .env.default ├── src ├── models │ ├── index.js │ ├── Note.js │ └── User.js ├── index.js ├── modules │ ├── index.js │ ├── Signup.js │ ├── Login.js │ └── TFA.js ├── utils │ ├── logger │ │ └── index.js │ ├── auth │ │ └── index.js │ └── db │ │ └── connection.js ├── resolvers │ ├── index.js │ ├── Signup.js │ ├── Login.js │ └── TFA.js ├── controllers │ ├── index.js │ └── graphql.js ├── API.js └── graphql │ └── schema.graphql ├── test ├── fixtures │ ├── signupFixture.json │ └── loginFixture.json ├── it-helper.js ├── Signup.test.js ├── Login.test.js └── TFA.test.js ├── .github ├── PULL_REQUEST_TEMPLATE.md ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md └── CODE_OF_CONDUCT.md ├── .prettierrc ├── README.md ├── .gitignore ├── package.json └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["@babel/preset-env"] 3 | } 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - '12' 4 | -------------------------------------------------------------------------------- /.env.default: -------------------------------------------------------------------------------- 1 | PORT=5000 2 | DB_URL=mongodb://example 3 | JWT_SECRET=reallylongsecret -------------------------------------------------------------------------------- /src/models/index.js: -------------------------------------------------------------------------------- 1 | export { default as Post } from './Note'; 2 | export { default as User } from './User'; 3 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import 'dotenv/config'; 2 | import API from './API.js'; 3 | 4 | const api = new API({ port: process.env.PORT }); 5 | 6 | api.start(); 7 | -------------------------------------------------------------------------------- /src/modules/index.js: -------------------------------------------------------------------------------- 1 | export { login, authorizeTFA } from './Login'; 2 | export { signup } from './Signup'; 3 | export { generateSecret, enableTFA, disableTFA, getBackupCodes } from './TFA'; 4 | -------------------------------------------------------------------------------- /src/utils/logger/index.js: -------------------------------------------------------------------------------- 1 | const log = (...args) => { 2 | const message = args[0]; 3 | const tags = args.slice(1).map((tag) => `[${tag}]`); 4 | console.log(...tags, message); 5 | } 6 | 7 | export default log; -------------------------------------------------------------------------------- /src/resolvers/index.js: -------------------------------------------------------------------------------- 1 | import loginResolvers from './Login'; 2 | import signupResolvers from './Signup'; 3 | import tfaResolvers from './TFA'; 4 | 5 | export default [loginResolvers, signupResolvers, tfaResolvers]; 6 | -------------------------------------------------------------------------------- /src/controllers/index.js: -------------------------------------------------------------------------------- 1 | import { Router } from 'express'; 2 | 3 | const router = Router(); 4 | 5 | router.get('*', (req, res) => { 6 | res.status(404).json({ code: 404, message: 'Endpoint not found' }); 7 | }); 8 | 9 | export default router; -------------------------------------------------------------------------------- /src/resolvers/Signup.js: -------------------------------------------------------------------------------- 1 | import { signup } from '../modules'; 2 | 3 | const signupResolvers = { 4 | Mutation: { 5 | signup: (_, args) => signup(args.email, args.password, args.name), 6 | }, 7 | }; 8 | 9 | export default signupResolvers; 10 | -------------------------------------------------------------------------------- /src/models/Note.js: -------------------------------------------------------------------------------- 1 | import { Schema, model } from 'mongoose'; 2 | 3 | const NoteSchema = new Schema({ 4 | _id: String, 5 | name: String, 6 | description: String, 7 | owner: String 8 | }); 9 | 10 | const Note = model('Note', NoteSchema); 11 | export default Note; 12 | -------------------------------------------------------------------------------- /src/utils/auth/index.js: -------------------------------------------------------------------------------- 1 | import { User } from '../../models'; 2 | 3 | export const isLoggedIn = async (payload, fields) => { 4 | if (!payload || !payload.id || payload.requiresTFA) return false; 5 | 6 | var response = await User.findById(payload.id, fields || '_id'); 7 | 8 | return response; 9 | }; 10 | -------------------------------------------------------------------------------- /src/resolvers/Login.js: -------------------------------------------------------------------------------- 1 | import { login, authorizeTFA } from '../modules'; 2 | 3 | const loginResolvers = { 4 | Mutation: { 5 | login: (_, args) => login(args.email, args.password, args.remember), 6 | authorizeTFA: (_, { token, backupCode }, { user }) => authorizeTFA(user, backupCode, token), 7 | }, 8 | }; 9 | 10 | export default loginResolvers; 11 | -------------------------------------------------------------------------------- /test/fixtures/signupFixture.json: -------------------------------------------------------------------------------- 1 | { 2 | "users": [ 3 | { 4 | "_id": "5d4c05af6b6f6c4c74184cc8", 5 | "name": "Jane Doe", 6 | "email": "jane.doe@example.com", 7 | "password": "$2b$10$d0GwwjPGoLmuAqTrjJ2vX.y35YNRG.czrOchZT1FYYyAQBCE42CQG", 8 | "username": "jane-doe-f63767", 9 | "backupCodes": null, 10 | "__v": 0, 11 | "tfa": null 12 | } 13 | ] 14 | } 15 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | **Please describe the changes this PR makes and why it should be merged:** 2 | 3 | **Semantic versioning classification:** 4 | - [ ] This PR changes the package's interface (methods or parameters added) 5 | - [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed) 6 | - [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc. 7 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "arrowParens": "always", 3 | "bracketSpacing": true, 4 | "htmlWhitespaceSensitivity": "css", 5 | "insertPragma": false, 6 | "jsxBracketSameLine": false, 7 | "jsxSingleQuote": true, 8 | "printWidth": 100, 9 | "proseWrap": "preserve", 10 | "quoteProps": "as-needed", 11 | "requirePragma": false, 12 | "semi": true, 13 | "singleQuote": true, 14 | "tabWidth": 2, 15 | "trailingComma": "es5", 16 | "useTabs": false, 17 | "endOfLine": "lf" 18 | } 19 | -------------------------------------------------------------------------------- /src/models/User.js: -------------------------------------------------------------------------------- 1 | import { Schema, model } from 'mongoose'; 2 | 3 | const BackupCodeSchema = new Schema({ 4 | code: String, 5 | used: Boolean, 6 | }); 7 | 8 | const UserSchema = new Schema({ 9 | _id: String, 10 | name: String, 11 | username: { type: String, unique: true }, 12 | password: String, 13 | email: { type: String, unique: true }, 14 | tfa: String, 15 | backupCodes: [BackupCodeSchema], 16 | }); 17 | 18 | const User = model('users', UserSchema); 19 | export default User; 20 | -------------------------------------------------------------------------------- /src/controllers/graphql.js: -------------------------------------------------------------------------------- 1 | import { ApolloServer } from 'apollo-server-express'; 2 | import { importSchema } from 'graphql-import'; 3 | import path from 'path'; 4 | import resolvers from '../resolvers'; 5 | 6 | const typeDefs = importSchema(path.join(__dirname, '..', 'graphql', 'schema.graphql')); 7 | 8 | const server = new ApolloServer({ 9 | typeDefs, 10 | resolvers, 11 | context: ({ req }) => ({ 12 | user: req.user, 13 | }), 14 | }); 15 | 16 | export default (app) => server.applyMiddleware({ app }); 17 | -------------------------------------------------------------------------------- /src/resolvers/TFA.js: -------------------------------------------------------------------------------- 1 | import { disableTFA, enableTFA, generateSecret, getBackupCodes } from '../modules'; 2 | 3 | const tfaResolvers = { 4 | Query: { 5 | generateSecret: (_, _args, { user }) => generateSecret(user), 6 | getBackupCodes: (_, _args, { user }) => getBackupCodes(user), 7 | }, 8 | Mutation: { 9 | enableTFA: (_, { secret, token }, { user }) => enableTFA(user, secret, token), 10 | disableTFA: (_, { token }, { user }) => disableTFA(user, token), 11 | }, 12 | }; 13 | 14 | export default tfaResolvers; 15 | -------------------------------------------------------------------------------- /src/utils/db/connection.js: -------------------------------------------------------------------------------- 1 | import { connect } from 'mongoose'; 2 | import log from '../logger/index.js'; 3 | 4 | export default (dbURL, options = {}, callback) => { 5 | connect( 6 | dbURL, 7 | options 8 | ) 9 | .then((db) => { 10 | log(`Successfully connected to ${dbURL}.`, 'API'); 11 | if (callback) callback(); 12 | return db; 13 | }) 14 | .catch((err) => { 15 | if (err.message.code === 'ETIMEDOUT') { 16 | log('Attempting to re-establish database connection.', 'API'); 17 | connect(dbURL); 18 | } else { 19 | log('Error while attempting to connect to database:', 'API'); 20 | log(err); 21 | } 22 | }); 23 | }; 24 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /test/it-helper.js: -------------------------------------------------------------------------------- 1 | import prepare from 'mocha-prepare'; 2 | import { start } from 'mongo-unit'; 3 | import dotenv from 'dotenv'; 4 | import connect from '../src/utils/db/connection'; 5 | import chai from 'chai'; 6 | import chaiAsPromised from 'chai-as-promised'; 7 | 8 | dotenv.config(); 9 | 10 | prepare((done) => { 11 | chai.use(chaiAsPromised); 12 | process.env.JWT_SECRET = 'test_token'; 13 | start().then((testMongoUrl) => { 14 | process.env.DB_URL = testMongoUrl; 15 | console.log('Connecting to mocked database...'); 16 | connect( 17 | process.env.DB_URL, 18 | { useNewUrlParser: true, useCreateIndex: true, useFindAndModify: false }, 19 | done 20 | ); 21 | }); 22 | }); 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 | API for the Perfectnote website.

4 | 5 | [![](https://img.shields.io/travis/perfectnote/api.svg?style=flat-square)](https://travis-ci.org/perfectnote/api) [![](https://david-dm.org/perfectnote/api/status.svg?style=flat-square)](https://david-dm.org/perfectnote/api) [![](https://david-dm.org/perfectnote/api/dev-status.svg?style=flat-square)](https://david-dm.org/perfectnote/api?type=dev) 6 |
7 | 8 | ## Setup 9 | **1. Fork the repository** (You don't have to do this if you're part of PerfectNote) 10 | 11 | **2. Clone your fork.** 12 | ```bash 13 | git clone https://github.com//api 14 | cd api 15 | ``` 16 | 17 | **3. Install all the dependencies with yarn.** 18 | ```bash 19 | yarn 20 | ``` 21 | 22 | **4. Build and start!** 23 | ``` 24 | yarn start 25 | ``` -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.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 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # Build files 64 | dist/ -------------------------------------------------------------------------------- /src/modules/Signup.js: -------------------------------------------------------------------------------- 1 | import { UserInputError } from 'apollo-server-express'; 2 | import { hash as hashPassword } from 'bcrypt'; 3 | import jsonwebtoken from 'jsonwebtoken'; 4 | import { mongo } from 'mongoose'; 5 | import { User } from '../models'; 6 | 7 | export const signup = async (email, password, name) => { 8 | if (!isEmailValid(email)) throw new UserInputError('Invalid email'); 9 | 10 | email = email.toLowerCase(); 11 | 12 | const hashedPassword = await hashPassword(password, 10); 13 | 14 | const username = `${email.split('@')[0].replace(/\W/g, '-')}-${Date.now() 15 | .toString(16) 16 | .slice(-6)}`; 17 | 18 | if ((await User.find({ $or: [{ email: email }, { username: username }] })).length !== 0) 19 | throw new UserInputError('Duplicate email'); 20 | 21 | const user = await User.create({ 22 | _id: new mongo.ObjectId(), 23 | name: name, 24 | email: email, 25 | password: hashedPassword, 26 | username, 27 | }); 28 | 29 | const token = jsonwebtoken.sign( 30 | { id: user._id, name: user.name, username: user.username }, 31 | process.env.JWT_SECRET, 32 | { expiresIn: '1y' } 33 | ); 34 | 35 | return { token, user }; 36 | }; 37 | 38 | const isEmailValid = (email) => { 39 | return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email); 40 | }; 41 | -------------------------------------------------------------------------------- /test/fixtures/loginFixture.json: -------------------------------------------------------------------------------- 1 | { 2 | "users": [ 3 | { 4 | "_id": "5d4c05af6b6f6c4c74184cc8", 5 | "name": "Jane Doe", 6 | "email": "jane.doe@example.com", 7 | "password": "$2b$10$d0GwwjPGoLmuAqTrjJ2vX.y35YNRG.czrOchZT1FYYyAQBCE42CQG", 8 | "username": "jane-doe-f63767", 9 | "backupCodes": null, 10 | "__v": 0, 11 | "tfa": null 12 | }, 13 | { 14 | "_id": "5d4d496bf11d944e28c574a8", 15 | "name": "John Doe", 16 | "email": "john.doe@example.com", 17 | "password": "$2b$10$kBaFe9mb5eXgtP5MK2JF5OZTnRxrXQiYaFmKWNk.FxJ9vq1I3/mla", 18 | "username": "john-doe-e6cb69", 19 | "backupCodes": [ 20 | { 21 | "code": "KU64Y6R5", 22 | "used": true 23 | }, 24 | { 25 | "code": "PLLPCCGD", 26 | "used": false 27 | }, 28 | { 29 | "code": "0PHNOCIA", 30 | "used": false 31 | }, 32 | { 33 | "code": "SFFZTXPP", 34 | "used": false 35 | }, 36 | { 37 | "code": "VYKCR5DH", 38 | "used": false 39 | }, 40 | { 41 | "code": "KQIBT4TT", 42 | "used": false 43 | }, 44 | { 45 | "code": "X89Q9COS", 46 | "used": false 47 | }, 48 | { 49 | "code": "BR5QBZDZ", 50 | "used": false 51 | }, 52 | { 53 | "code": "7MO9BL73", 54 | "used": false 55 | }, 56 | { 57 | "code": "MN03HKGC", 58 | "used": false 59 | } 60 | ], 61 | "__v": 0, 62 | "tfa": "JBUXI42XH5QUEORJLM4HIQSEOVNSSVDMIN4U4ORFKFIXG7JUGRVQ" 63 | } 64 | ] 65 | } 66 | -------------------------------------------------------------------------------- /test/Signup.test.js: -------------------------------------------------------------------------------- 1 | import { UserInputError } from 'apollo-server-core'; 2 | import { compare as comparePassword } from 'bcrypt'; 3 | import { expect } from 'chai'; 4 | import jwt from 'jsonwebtoken'; 5 | import mongoUnit from 'mongo-unit'; 6 | import { signup } from '../src/modules/Signup'; 7 | import signupFixture from './fixtures/signupFixture.json'; 8 | 9 | describe('modules/Signup', () => { 10 | before(() => mongoUnit.load(signupFixture)); 11 | after(() => mongoUnit.clean(signupFixture)); 12 | 13 | it('should register a pre-defined user correctly', async () => { 14 | var data = await signup('john.doe@example.com', 'password123456', 'John Doe'); 15 | 16 | expect(data.token).to.be.a('string', 'token is not a string'); 17 | expect(data.user).to.not.be.a('undefined', "user object can't be undefined"); 18 | expect(data.user._id).to.be.a('string', 'id is not a swtring'); 19 | expect(data.user.name).to.be.equal('John Doe', "name doesn't match what was provided"); 20 | expect(data.user.email).to.be.equals( 21 | 'john.doe@example.com', 22 | "email doesn't match what was provided" 23 | ); 24 | await expect(comparePassword('password123456', data.user.password), 'passwords should match').to 25 | .eventually.be.true; 26 | expect(data.user.username).to.match(/john-doe-[\d\w]{6}/, "username isn't correctly setup"); 27 | 28 | expect(jwt.verify(data.token, process.env.JWT_SECRET)) 29 | .to.be.an('object') 30 | .that.includes.all.keys('id', 'name', 'username'); 31 | }); 32 | 33 | it('should throw error for invalid email', () => 34 | expect(signup('john.doe', 'password123456', 'John Doe')).to.be.rejectedWith(UserInputError)); 35 | 36 | it('should throw error for duplicate email', () => 37 | expect(signup('john.doe@example.com', 'password123456', 'John Doe')).to.be.rejectedWith(Error)); 38 | }); 39 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "perfectnote-api", 3 | "version": "0.0.1", 4 | "description": "PerfectNote's API, built with NodeJS, Express, and MongoDB.", 5 | "main": "./src/index.js", 6 | "repository": { 7 | "type": "git", 8 | "url": "git+https://github.com/cringiest/grumpy.git" 9 | }, 10 | "author": "PerfectNote", 11 | "license": "GPL-3.0", 12 | "private": false, 13 | "keywords": [ 14 | "perfectnote", 15 | "api", 16 | "server" 17 | ], 18 | "bugs": { 19 | "url": "https://github.com/perfectnote/api/issues" 20 | }, 21 | "homepage": "https://github.com/perfectnote/api", 22 | "scripts": { 23 | "start": "nodemon --exec babel-node src/index.js", 24 | "clean": "prettier --write \"src/*.js\"", 25 | "test": "mocha --require core-js/stable --require regenerator-runtime/runtime --require @babel/register --require test/it-helper.js --exit test/*.test.js" 26 | }, 27 | "dependencies": { 28 | "apollo-server-express": "^2.8.1", 29 | "bcrypt": "^3.0.6", 30 | "body-parser": "^1.19.0", 31 | "chai-as-promised": "^7.1.1", 32 | "compression": "^1.7.4", 33 | "cors": "^2.8.5", 34 | "dotenv": "^8.0.0", 35 | "express": "^4.17.1", 36 | "express-bearer-token": "^2.4.0", 37 | "express-rate-limit": "^5.0.0", 38 | "graphql": "^14.4.2", 39 | "graphql-import": "^0.7.1", 40 | "grumpy": "^0.2.3", 41 | "helmet": "^3.20.0", 42 | "jsonwebtoken": "^8.5.1", 43 | "lodash": "^4.17.15", 44 | "mongoose": "^5.6.9", 45 | "morgan": "^1.9.1", 46 | "node-fetch": "^2.6.0", 47 | "passport": "^0.4.0", 48 | "passport-jwt": "^4.0.0", 49 | "qrcode": "^1.4.1", 50 | "speakeasy": "^2.0.0" 51 | }, 52 | "devDependencies": { 53 | "@babel/cli": "^7.5.5", 54 | "@babel/core": "^7.5.5", 55 | "@babel/node": "^7.5.5", 56 | "@babel/preset-env": "^7.5.5", 57 | "@babel/register": "^7.5.5", 58 | "@types/node": "^12.6.9", 59 | "chai": "^4.2.0", 60 | "core-js": "^3.1.4", 61 | "eslint": "^6.1.0", 62 | "mocha": "^6.2.0", 63 | "mocha-prepare": "^0.1.0", 64 | "mongo-unit": "^1.4.4", 65 | "nodemon": "^1.19.1", 66 | "prettier": "^1.18.2", 67 | "supertest": "^4.0.2" 68 | }, 69 | "engines": { 70 | "node": ">=8.0.0" 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /src/API.js: -------------------------------------------------------------------------------- 1 | import bodyParser from 'body-parser'; 2 | import compression from 'compression'; 3 | import cors from 'cors'; 4 | import express from 'express'; 5 | import tokenBearer from 'express-bearer-token'; 6 | import rateLimit from 'express-rate-limit'; 7 | import helmet from 'helmet'; 8 | import morgan from 'morgan'; 9 | import passport from 'passport'; 10 | import { ExtractJwt, Strategy } from 'passport-jwt'; 11 | import setupGraphql from './controllers/graphql.js'; 12 | import globalRoute from './controllers/index.js'; 13 | import connect from './utils/db/connection.js'; 14 | import log from './utils/logger/index.js'; 15 | 16 | const app = express(); 17 | const db = connect( 18 | process.env.DB_URL, 19 | { useNewUrlParser: true, useCreateIndex: true, useFindAndModify: false } 20 | ); 21 | 22 | export default class Wrapper { 23 | constructor(options = {}) { 24 | this.options = options; 25 | this.log = log; 26 | } 27 | 28 | start(port = this.options.port || process.env.PORT || 5000) { 29 | app.enable('trust proxy', true); 30 | 31 | app.use(morgan('combined')); 32 | app.use(bodyParser.json()); 33 | app.use(bodyParser.urlencoded({ extended: true })); 34 | app.use(helmet()); 35 | app.use(compression()); 36 | app.use(cors()); 37 | app.use(tokenBearer()); 38 | app.use( 39 | rateLimit({ 40 | windowMs: 10000, 41 | max: 50, 42 | headers: true, 43 | handler: (_req, res) => { 44 | res.status(429).json({ code: 429, message: 'Too many requests' }); 45 | }, 46 | }) 47 | ); 48 | 49 | // Add JWT strategy to Passport 50 | passport.use( 51 | new Strategy( 52 | { 53 | secretOrKey: process.env.JWT_SECRET, 54 | jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(), 55 | }, 56 | (payload, done) => done(null, payload) 57 | ) 58 | ); 59 | 60 | passport.initialize(); 61 | 62 | app.use('/graphql', (req, res, next) => { 63 | passport.authenticate('jwt', { session: false }, (_err, user) => { 64 | if (user) req.user = user; 65 | 66 | next(); 67 | })(req, res, next); 68 | }); 69 | 70 | setupGraphql(app); 71 | app.use(globalRoute); 72 | 73 | app.listen(port, () => { 74 | this.log(`Listening on port ${port}`, 'API'); 75 | }); 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /src/modules/Login.js: -------------------------------------------------------------------------------- 1 | import { AuthenticationError, UserInputError } from 'apollo-server-express'; 2 | import { compare as comparePassword } from 'bcrypt'; 3 | import jsonwebtoken from 'jsonwebtoken'; 4 | import speakeasy from 'speakeasy'; 5 | import { User } from '../models'; 6 | 7 | export const login = async (email, password, remember) => { 8 | email = email.toLowerCase(); 9 | const user = await User.findOne({ email }, 'name email username password tfa'); 10 | if (!user) throw new UserInputError('Wrong email'); 11 | 12 | const match = await comparePassword(password, user.password); 13 | if (!match) throw new UserInputError('Wrong password'); 14 | 15 | var token; 16 | if (!!user.tfa) { 17 | token = jsonwebtoken.sign( 18 | { id: user._id, requiresTFA: true, remember: remember }, 19 | process.env.JWT_SECRET, 20 | { 21 | expiresIn: '30m', 22 | } 23 | ); 24 | } else { 25 | token = jsonwebtoken.sign( 26 | { id: user._id, name: user.name, username: user.username }, 27 | process.env.JWT_SECRET, 28 | { expiresIn: remember ? '1y' : '1d' } 29 | ); 30 | } 31 | 32 | return { token, requiresTFA: !!user.tfa, user }; 33 | }; 34 | 35 | export const authorizeTFA = async (payload, backupCode, token) => { 36 | if (!payload) throw new AuthenticationError('Must have gone through the first factor auth'); 37 | if (!payload.requiresTFA) throw new UserInputError('User does not need to authorize TFA'); 38 | 39 | if (backupCode) { 40 | // TODO maybe it's possible to do everything in one query? 41 | var { backupCodes, name, username } = await User.findById( 42 | payload.id, 43 | 'backupCodes name username' 44 | ); 45 | const codeIndex = backupCodes.findIndex((code) => code.code === token && !code.used); 46 | if (codeIndex === -1) throw new AuthenticationError('Invalid backup code'); 47 | backupCodes[codeIndex].used = true; 48 | await User.updateOne({ _id: payload.id }, { backupCodes }); 49 | } else { 50 | var { tfa, name, username } = await User.findById(payload.id, 'tfa name username'); 51 | 52 | const verified = speakeasy.totp.verify({ secret: tfa, encoding: 'base32', token, window: 2 }); 53 | if (!verified) throw new AuthenticationError('Invalid token'); 54 | } 55 | return { 56 | token: jsonwebtoken.sign({ id: payload.id, name, username }, process.env.JWT_SECRET, { 57 | expiresIn: payload.remember ? '1y' : '1d', 58 | }), 59 | }; 60 | }; 61 | -------------------------------------------------------------------------------- /src/modules/TFA.js: -------------------------------------------------------------------------------- 1 | import { AuthenticationError, UserInputError } from 'apollo-server-express'; 2 | import QRCode from 'qrcode'; 3 | import speakeasy from 'speakeasy'; 4 | import { User } from '../models'; 5 | import { isLoggedIn } from '../utils/auth'; 6 | 7 | export const generateSecret = async (payload) => { 8 | if (!(await isLoggedIn(payload))) throw new AuthenticationError('Must be logged in'); 9 | 10 | const secret = speakeasy.generateSecret({ name: `${payload.name}:PerfectNote` }); 11 | const qrcode = await QRCode.toDataURL(secret.otpauth_url); 12 | 13 | return { secret: secret.base32, qrcode }; 14 | }; 15 | 16 | export const enableTFA = async (payload, secret, token) => { 17 | var user = await isLoggedIn(payload, 'tfa'); 18 | if (!user) throw new AuthenticationError('Must be logged in'); 19 | 20 | if (!!user.tfa) throw new UserInputError('User already has TFA enabled'); 21 | 22 | const verified = speakeasy.totp.verify({ 23 | secret, 24 | encoding: 'base32', 25 | token, 26 | window: 2, 27 | }); 28 | if (!verified) throw new UserInputError('Invalid token'); 29 | 30 | const backupCodes = generateBackupCodes(); 31 | 32 | await User.updateOne({ _id: payload.id }, { tfa: secret, backupCodes }); 33 | 34 | return backupCodes; 35 | }; 36 | 37 | export const disableTFA = async (payload, token) => { 38 | var user = await isLoggedIn(payload, 'tfa'); 39 | if (!user) throw new AuthenticationError('Must be logged in'); 40 | 41 | if (!user.tfa) throw new UserInputError('TFA is not enabled'); 42 | 43 | const verified = speakeasy.totp.verify({ 44 | secret: user.tfa, 45 | encoding: 'base32', 46 | token, 47 | window: 2, 48 | }); 49 | if (!verified) throw new UserInputError('Invalid token'); 50 | 51 | await User.updateOne({ _id: payload.id }, { tfa: undefined, backupCodes: undefined }); 52 | 53 | return payload.id; 54 | }; 55 | 56 | export const getBackupCodes = async (payload) => { 57 | var user = await isLoggedIn(payload, 'backupCodes'); 58 | if (!user) throw new AuthenticationError('Must be logged in'); 59 | 60 | if (!user.backupCodes) throw new UserInputError('TFA is not enabled'); 61 | 62 | return user.backupCodes; 63 | }; 64 | 65 | const generateBackupCodes = () => { 66 | const gen = (length) => { 67 | let result = ''; 68 | const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'; 69 | const charactersLength = characters.length; 70 | for (let i = 0; i < length; i++) { 71 | result += characters.charAt(Math.floor(Math.random() * charactersLength)); 72 | } 73 | return result; 74 | }; 75 | const backupCodes = []; 76 | for (let i = 0; i < 10; i++) { 77 | backupCodes.push({ code: gen(8), used: false }); 78 | } 79 | return backupCodes; 80 | }; 81 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at support@perfectnote.org. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /test/Login.test.js: -------------------------------------------------------------------------------- 1 | import { AuthenticationError, UserInputError } from 'apollo-server-core'; 2 | import { expect } from 'chai'; 3 | import jwt from 'jsonwebtoken'; 4 | import mongoUnit from 'mongo-unit'; 5 | import speakeasy from 'speakeasy'; 6 | import { authorizeTFA, login } from '../src/modules/Login'; 7 | import loginFixture from './fixtures/loginFixture.json'; 8 | 9 | describe('modules/Login', () => { 10 | before(() => mongoUnit.load(loginFixture)); 11 | after(() => mongoUnit.clean(loginFixture)); 12 | 13 | describe('login', () => { 14 | context('without two-factor authentication', () => { 15 | it('should login successfuly when valid credentials are given', async () => { 16 | var response = await login('jane.doe@example.com', 'test123', false); 17 | expect(response.requiresTFA, "shouldn't require tfa").to.be.false; 18 | expect(response.token, 'token should be a string').to.be.a('string'); 19 | expect(response.user, "user object can't be undefined").to.not.be.an('undefined'); 20 | expect(response.user._id, 'user id to be a string').to.be.a('string'); 21 | expect(response.user.name, 'user.name to be Jane Doe').to.be.equals('Jane Doe'); 22 | expect(response.user.email, 'user.email to be jane.doe@example.com').to.be.equals( 23 | 'jane.doe@example.com' 24 | ); 25 | expect(response.user.username, 'user.username to match /jane-doe-[\\w\\d]{6}/').to.match( 26 | /jane-doe-[\w\d]{6}/ 27 | ); 28 | expect( 29 | jwt.verify(response.token, process.env.JWT_SECRET), 30 | 'token payload to contain correct keys' 31 | ) 32 | .to.be.an('object') 33 | .that.includes.all.keys('id', 'name', 'username'); 34 | }); 35 | it('should fail if email is wrong', () => 36 | expect(login('not.jane.doe@example.com', 'test123', false)).to.be.rejectedWith( 37 | UserInputError, 38 | 'Wrong email' 39 | )); 40 | it('should fail if password is wrong', () => 41 | expect(login('jane.doe@example.com', 'wrongpassword', false)).to.be.rejectedWith( 42 | UserInputError, 43 | 'Wrong password' 44 | )); 45 | }); 46 | context('with two-factor-authentication', () => { 47 | it('should ask for two-factor authentication', async () => { 48 | var response = await login('john.doe@example.com', 'test123', false); 49 | expect(response.token, 'token should be a string').to.be.a('string'); 50 | expect(response.requiresTFA, 'response should say TFA is required').to.be.true; 51 | expect( 52 | jwt.verify(response.token, process.env.JWT_SECRET), 53 | 'token payload to contain correct keys' 54 | ) 55 | .to.be.an('object') 56 | .that.includes.all.keys('id', 'requiresTFA', 'remember'); 57 | }); 58 | }); 59 | }); 60 | 61 | describe('authorizeTFA', () => { 62 | const token = { id: '5d4d496bf11d944e28c574a8', requiresTFA: true, remember: false }; 63 | const secret = 'JBUXI42XH5QUEORJLM4HIQSEOVNSSVDMIN4U4ORFKFIXG7JUGRVQ'; 64 | 65 | it('should throw an error when no token is given', () => 66 | expect(authorizeTFA(undefined, false, '123456'), 'should be rejected').to.be.rejectedWith( 67 | AuthenticationError 68 | )); 69 | it('should throw an error if token payload does not include requireTFA', () => 70 | expect( 71 | authorizeTFA({ ...token, requiresTFA: false }, false, '123456'), 72 | 'should be rejected' 73 | ).to.be.rejectedWith(UserInputError)); 74 | it('should authenticate successfully with time generated token', () => 75 | expect( 76 | authorizeTFA(token, false, speakeasy.totp({ secret, encoding: 'base32' })), 77 | 'should return new token' 78 | ) 79 | .to.eventually.be.an('object') 80 | .that.has.key('token')); 81 | it('should authenticate successfully with backup code', () => 82 | expect(authorizeTFA(token, true, 'PLLPCCGD'), 'should return new token') 83 | .to.eventually.be.an('object') 84 | .that.has.key('token')); 85 | it('should throw an error when a used backup code is provided', () => 86 | expect(authorizeTFA(token, true, 'KU64Y6R5'), 'should throw error').to.be.rejectedWith( 87 | AuthenticationError 88 | )); 89 | it('should throw an error when invalid time generated token is provided', () => 90 | expect(authorizeTFA(token, false, '123456'), 'should throw error').to.be.rejectedWith( 91 | AuthenticationError 92 | )); 93 | it('should throw an error when invalid backup code is provided', () => 94 | expect(authorizeTFA(token, true, 'GHSI542K'), 'should throw error').to.be.rejectedWith( 95 | AuthenticationError 96 | )); 97 | }); 98 | }); 99 | -------------------------------------------------------------------------------- /test/TFA.test.js: -------------------------------------------------------------------------------- 1 | import { AuthenticationError, UserInputError } from 'apollo-server-core'; 2 | import { expect } from 'chai'; 3 | import mongoUnit from 'mongo-unit'; 4 | import speakeasy from 'speakeasy'; 5 | import { disableTFA, enableTFA, generateSecret, getBackupCodes } from '../src/modules/TFA'; 6 | import tfaFixture from './fixtures/loginFixture.json'; 7 | 8 | describe('modules/TFA', () => { 9 | beforeEach(() => mongoUnit.load(tfaFixture)); 10 | afterEach(() => mongoUnit.clean(tfaFixture)); 11 | 12 | const janeDoeToken = { 13 | id: '5d4c05af6b6f6c4c74184cc8', 14 | name: 'Jane Doe', 15 | username: 'jane-doe-f63767', 16 | }; 17 | 18 | const johnDoeToken = { 19 | id: '5d4d496bf11d944e28c574a8', 20 | name: 'John Doe', 21 | username: 'john-doe-e6cb69', 22 | }; 23 | 24 | describe('generateSecret', () => { 25 | it('should throw an error if user is not logged in', () => 26 | expect(generateSecret(undefined), 'should throw an error').to.be.rejectedWith( 27 | AuthenticationError 28 | )); 29 | 30 | it('should generate a random secret', async () => { 31 | const result = await generateSecret(janeDoeToken); 32 | expect(result.secret, 'secret should be a string').to.be.a('string'); 33 | expect(result.qrcode, 'qrcode should be a base64 encoded image') 34 | .to.be.a('string') 35 | .that.matches(/^data:image\/png;base64,[\w/+=]+$/); 36 | }); 37 | }); 38 | 39 | describe('enableTFA', () => { 40 | it('should throw an error if user is not logged in', () => 41 | expect(enableTFA(undefined, '', ''), 'should throw an error').to.be.rejectedWith( 42 | AuthenticationError 43 | )); 44 | 45 | it('should throw an error for users with TFA already enabled', async () => { 46 | const randomSecret = speakeasy.generateSecret(); 47 | await expect( 48 | enableTFA( 49 | johnDoeToken, 50 | randomSecret.base32, 51 | speakeasy.totp({ secret: randomSecret.ascii }) 52 | ), 53 | 'should throw an error' 54 | ).to.be.rejectedWith(UserInputError); 55 | }); 56 | 57 | it('should enable TFA when correct data is passed', async () => { 58 | const randomSecret = speakeasy.generateSecret(); 59 | await expect( 60 | enableTFA( 61 | janeDoeToken, 62 | randomSecret.base32, 63 | speakeasy.totp({ secret: randomSecret.ascii }) 64 | ), 65 | 'should return backup codes' 66 | ).to.eventually.be.an('array').that.is.not.empty; 67 | }); 68 | }); 69 | 70 | describe('disableTFA', () => { 71 | it('should throw an error if user is not logged in', () => 72 | expect(disableTFA(undefined, ''), 'should throw an error').to.be.rejectedWith( 73 | AuthenticationError 74 | )); 75 | 76 | it('should throw an error if user does not have TFA enabled', () => 77 | expect(disableTFA(janeDoeToken, '123456'), 'should throw an error').to.be.rejectedWith( 78 | UserInputError 79 | )); 80 | 81 | it('should throw an error if token is wrong', () => 82 | expect(disableTFA(johnDoeToken, '123456'), 'should throw an error').to.be.rejectedWith( 83 | UserInputError 84 | )); 85 | 86 | it('should disable tfa for correct token', () => 87 | expect( 88 | disableTFA( 89 | johnDoeToken, 90 | speakeasy.totp({ 91 | secret: 'JBUXI42XH5QUEORJLM4HIQSEOVNSSVDMIN4U4ORFKFIXG7JUGRVQ', 92 | encoding: 'base32', 93 | }) 94 | ), 95 | 'should return user id' 96 | ).to.eventually.be.equals('5d4d496bf11d944e28c574a8')); 97 | }); 98 | 99 | describe('getBackupCodes', () => { 100 | it('should throw an error if user is not logged in', () => 101 | expect(getBackupCodes(undefined), 'should throw an error').to.be.rejectedWith( 102 | AuthenticationError 103 | )); 104 | 105 | it('should throw an error if user does not have TFA enabled', () => 106 | expect(getBackupCodes(janeDoeToken), 'should throw an error').to.be.rejectedWith( 107 | UserInputError 108 | )); 109 | 110 | it('should return backup codes', async () => { 111 | const backupCodes = getBackupCodes(johnDoeToken); 112 | expect(backupCodes, 'must be array with length 10') 113 | .to.eventually.be.an('array') 114 | .that.has.length(10); 115 | for (let i = 0; i < backupCodes.length; i++) { 116 | let backupCode = backupCodes[i]; 117 | expect(backupCode, 'array children must be an object').to.be.an('object'); 118 | expect(backupCode.code, 'code must be a string').to.be.a('string'); 119 | expect(backupCode.used, 'used must be a boolean').to.be.a('boolean'); 120 | } 121 | }); 122 | }); 123 | }); 124 | -------------------------------------------------------------------------------- /src/graphql/schema.graphql: -------------------------------------------------------------------------------- 1 | type Query { 2 | """ 3 | **Requires authentication.** 4 | 5 | Generates a secret and a QRCode so the user can enable TFA afterwards. 6 | Recommended flow is to call `mutation enableTFA` after this. 7 | """ 8 | generateSecret: TFAPayload 9 | """ 10 | **Requires authentication.** 11 | 12 | Fetches the backup codes for the current user. 13 | Returns null if TFA isn't enabled. 14 | """ 15 | getBackupCodes: [BackupCode] 16 | } 17 | 18 | type Mutation { 19 | "Adds a user to the database with the provided data. The token returned is valid for 1 year." 20 | signup( 21 | "The email of the user. Must match the standard email format: `example@example.com`." 22 | email: String! 23 | """ 24 | A password for the user. 25 | There's currently no limit of how many characters nor which characters are allowed. 26 | **However, that might change the the future.** 27 | """ 28 | password: String! 29 | """ 30 | The display name of the user. 31 | It should have the ` ` format, although it is not checked. 32 | 33 | This is diferent from the `username`, which is randomly generated based on the email and can also be changed later. 34 | """ 35 | name: String! 36 | ): AuthPayload 37 | """ 38 | Returns an authorization token which allows the user to access other endpoints. 39 | 40 | Depending if the user has TFA enabled, the returned token might have a diferent payload. 41 | Refer to `AuthPayload.token` for more information. 42 | 43 | If TFA is enabled, the client needs to call `mutation authorizeTFA` to get an authorized token. 44 | """ 45 | login( 46 | "The email associated with the account." 47 | email: String! 48 | "The password to login into the account." 49 | password: String! 50 | """ 51 | Whether the user has selected to remeber the account on the device. 52 | If `false` the token will be valid for 1 day. Otherwise, the token will be valid for a whole year. 53 | """ 54 | remember: Boolean 55 | ): AuthPayload 56 | """ 57 | **Requires an authorization token that is waiting for TFA authentication.** 58 | 59 | Using a one-time code or a backup code, this returns an AuthPayload with another token (see `AuthPayload.token`). 60 | The `AuthPayload.user` field returns `null`. 61 | 62 | If the authorization token included doesn't have `requireTFA: true` in the payload, an error is thrown. 63 | """ 64 | authorizeTFA( 65 | "The 6-digit time generated token or a backup code if `backupCode` is `true`." 66 | token: String! 67 | "If `true`, the `token` field takes a backup code instead of a time generated token." 68 | backupCode: Boolean 69 | ): AuthPayload! 70 | """ 71 | **Requires authentication.** 72 | 73 | Enables TFA for the current user or replaced the current secret with another one. 74 | 75 | It is recommended to get a `secret` from `query generateSecret`. 76 | """ 77 | enableTFA( 78 | "The secret used to generate the time based tokens. Although not required, it should be requested from `query generateSecret`." 79 | secret: String! 80 | """ 81 | The 6-digit time based token. 82 | Used to make sure the user has properly setup TFA. 83 | """ 84 | token: String! 85 | ): [BackupCode!]! 86 | """ 87 | **Requires authentication.** 88 | 89 | Disables TFA for the current user. 90 | """ 91 | disableTFA( 92 | """ 93 | The 6-digit time based token. 94 | Used to make sure it's the account owner disabling TFA and not someone who happened to be using the account. 95 | """ 96 | token: String! 97 | ): ID! 98 | } 99 | 100 | type AuthPayload { 101 | """ 102 | A [JWT token](https://jwt.io). 103 | 104 | The payload in the token depends on authentication state: 105 | * If the user has logged in and doesn't have TFA enable _OR_ if the user has entered the TFA token already, the payload has the following layout: 106 | ```json 107 | { 108 | "id": "5d4a9...", 109 | "name": "John Doe", 110 | "username": "john-doe-795b75" 111 | } 112 | ``` 113 | * If the user has logged in but does have TFA enable, the `mutation login` endpoint will return the following layout: 114 | ```json 115 | { 116 | "id": "5d4a9...", 117 | "requiresTFA": true, 118 | "remember": true/false 119 | } 120 | ``` 121 | """ 122 | token: String 123 | "Returns true if clients needs to get another token from the `mutation authorizeTFA` endpoint after login." 124 | requiresTFA: Boolean 125 | "The user that is logged in." 126 | user: User 127 | } 128 | 129 | type User { 130 | "The ID of the user. This is randomly generated by the backend and cannot be changed." 131 | id: ID! 132 | """ 133 | The display name of the user. 134 | It should have the ` ` format, although it can be any string. 135 | 136 | This is diferent from the `username`, which is randomly generated based on the email and can also be changed later. 137 | """ 138 | name: String! 139 | "The email of the user. Matches the standard email format: `example@example.com`." 140 | email: String! 141 | """ 142 | When an account is created, this is randomly generated based on the email (eg. `john.doe@gmail.com` might produce `john-doe-ff4153`). 143 | The last 6 digits of the username are generated based on the current timestamp to avoid duplicate usernames. 144 | 145 | This username can be changed later by the user. 146 | The username might be used later on for other features like public notebooks (eg. might be included in the URL). 147 | """ 148 | username: String! 149 | } 150 | 151 | type TFAPayload { 152 | "The secret to enable TFA, encoded in base32." 153 | secret: String! 154 | "The data URI of the QRCode used to add the TFA account to Authy, Google Authenticator, etc. Encoded in base64." 155 | qrcode: String! 156 | } 157 | 158 | type BackupCode { 159 | "The code itself, which matches `[A-Z\\d]{8}`." 160 | code: String! 161 | "Returns `true` if the code has been used and can't be used again. Otherwise, returns `false`." 162 | used: Boolean! 163 | } 164 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------