screwdriver-data-schema/models/token.js

Internal Data Schema of Screwdriver

'use strict';

const Joi = require('joi');
const mutate = require('../lib/mutate');
// Token hash length, measured in bits
const HASH_LENGTH = 512;
// Calculate the character length of the base64 string representing HASH_LENGTH bits
// Each base64 character represents 6 bits of data
const HASH_BASE64_LENGTH = Math.ceil(HASH_LENGTH / 6);

const MODEL = {
    id: Joi.number().integer().positive(),

    hash: Joi.string()
        // Using https://www.npmjs.com/package/base64url
        .regex(/[a-zA-Z0-9_-]+/)
        .length(HASH_BASE64_LENGTH)
        .description('Hashed token value'),

    userId: Joi.number().integer().positive().description('User ID'),

    pipelineId: Joi.number().integer().positive().description('Pipeline ID').example(123345),

    name: Joi.string().max(128).description('Token name').example('Mobile token'),

    description: Joi.string()
        .max(256)
        .allow('')
        .description('Token description')
        .example('Used to authenticate the mobile app'),

    lastUsed: Joi.string().isoDate().allow('').description('Last used')
};

module.exports = {
    /**
     * All the available properties of Token
     *
     * @property base
     * @type {Joi}
     */
    base: Joi.object(MODEL).without('userId', 'pipelineId').label('Token'),

    /**
     * All the available properties of Token
     *
     * @property fields
     * @type {Object}
     */
    fields: MODEL,

    /**
     * Properties for token that will come back during a GET request
     *
     * @property get
     * @type {Joi}
     */
    get: Joi.object(mutate(MODEL, ['id', 'name', 'lastUsed'], ['description'])).label('Get tokens'),

    /**
     * Properties for Token that will be passed during a CREATE request
     *
     * @property create
     * @type {Joi}
     */
    create: Joi.object(mutate(MODEL, ['name'], ['description'])).label('Create token'),

    /**
     * Properties for token that will be passed during a UPDATE requeste
     *
     * @property update
     * @type {Joi}
     */
    update: Joi.object(mutate(MODEL, [], ['name', 'description'])).label('Update token metadata'),

    /**
     * List of fields that determine a unique row
     *
     * @property keys
     * @type {Array}
     */
    keys: ['hash'],

    /**
     * List of all fields in the model
     * @property allKeys
     * @type {Array}
     */
    allKeys: Object.keys(MODEL),

    /**
     * Tablename to be used in the datastore
     *
     * @property tableName
     * @type {String}
     */
    tableName: 'tokens',

    /**
     * List of indexes to create in the datastore
     *
     * @property indexes
     * @type {Array}
     */
    indexes: [{ fields: ['hash'] }, { fields: ['userId'] }, { fields: ['pipelineId'] }]
};