@loopback/security/src/index.ts

A LoopBack component for security support.

// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
// Node module: @loopback/security
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

/**
 * Common types/interfaces for LoopBack 4 security including authentication and
 * authorization.
 *
 * @remarks
 * - Subject
 *   - It's the "who" for security
 *   - contains a set of Principles, a set of Credentials, and a set of
 *     Permissions
 * - Principle
 *   - Represent a user, an application, or a device
 * - Credential
 *   - Security attributes used to authenticate the subject. Such credentials
 *     include passwords, Kerberos tickets, and public key certificates.
 * - Permission
 *   - It's the what for security.
 *
 * @packageDocumentation
 */

export * from './keys';
export * from './types';