@creatio-tech/security v2.0.0

Creatio.Security

Creatio.Security it is a Node JS package that contains all application security components. This package can be applied to any web component such as:

• NodeJS Envs
• Cloud Function
• Google App Engine
• Google Cloud Run
• Google Kubernate Engine
• Node Express Server

Getting Started

1. Install enviroment (NodeJS)
2. Install dependencies: npm install
3. Build: npm run build
4. Publish: npm publish

Build and Test

• Build: npm run build
• Test: npm run test
• TDD: npm run tdd

Documentation

Creatio Packages Dependencies

TypeDocs

Creatio TypeDocs

Table of Contents

• Entity
  • TokenResult
• Enum
  • SecretManagerType
• Service
  • ICasRestAuthenticationService
  • CasRestAuthenticationService
  • ICloudKeyManagementService
  • CloudKeyManagementService
  • ICryptoEncryptionService
  • CryptoEncryptionService
  • IFirebaseAuthenticationService
  • FirebaseAuthenticationService
  • IFirebaseAuthorizationService
  • FirebaseAuthorizationService
  • IGoogleAuthenticationService
  • GoogleAuthenticationService
  • IGoogleAuthorizationService
  • GoogleAuthorizationService
  • IGooglePlatformAuthorizationService
  • GooglePlatformAuthorizationService
  • IStaticTokenAuthorizationService
  • StaticTokenAuthorizationService
  • ICloudSecretManagerService
  • CloudSecretManagerService
• Locator
  • SecurityServiceLocator
• Helper
  • HeaderRequestHelper

Entity

Security entities

TokenResult

Token Result Entity

Enum

Enums set to manage types

SecretManagerType

Application Secret Manager Type [file_kms_secrets, google_secret_manager]

Service

Service package set for NodeJS components

ICasRestAuthenticationService

Inferface responsible for handling the CAS Authetntication

CasRestAuthenticationService

Service responsible for handling the CAS Authetntication

ICloudKeyManagementService

Inferface responsible for managing integration with Cloud Key Management Service

CloudKeyManagementService

Service responsible for managing integration with Cloud Key Management Service

ICryptoEncryptionService

Inferface responsible for handling encrypted data with Crypto

CryptoEncryptionService

Service responsible for handling encrypted data with Crypto

IFirebaseAuthenticationService

Inferface responsible for managing authentication with Firebase Administrator

FirebaseAuthenticationService

Service responsible for managing authentication with Firebase Administrator

IFirebaseAuthorizationService

Inferface responsible for managing authorization with Firebase Administrator

FirebaseAuthorizationService

Service responsible for managing authorization with Firebase Administrator

IGoogleAuthenticationService

Inferface responsible for managing authentication with Google AUTH

GoogleAuthenticationService

Service responsible for managing authentication with Google AUTH

IGoogleAuthorizationService

Inferface responsible for managing authorization with Google AUTH

GoogleAuthorizationService

Service responsible for managing authorization with Google AUTH

IGooglePlatformAuthorizationService

Inferface responsible for managing authorization for Google Plataform

GooglePlatformAuthorizationService

Service responsible for managing authorization for Google Plataform

IStaticTokenAuthorizationService

Inferface responsible for handling static tokens

StaticTokenAuthorizationService

Service responsible for handling static tokens

ICloudSecretManagerService

Inferface responsible for handling Google Cloud Secret Manager

CloudSecretManagerService

Service responsible for handling Google Cloud Secret Manager

Locator

Locator Service for security

SecurityServiceLocator

Service responsible for the management of all security services

Helper

Utility package set for NodeJS components

HeaderRequestHelper

Class to handle header request in the apps

Contribute

If you are interested in fixing issues and contributing directly to the code, please contact to the project manager. Here is how you can contribute to Creatio.Security:

• Submit bugs and help us verify fixes
• Submit pull requests for bug fixes and features and discuss existing proposals