Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Censor

Index

Properties

Static Readonly CENSOR_RESPONSE

CENSOR_RESPONSE: "****" = "****"

Static Private Readonly MAIN_CENSORED_OPTIONS

MAIN_CENSORED_OPTIONS: string[] = ["auth", "authentication", "basicAuth", "certFilePassphrase", "credentials","pw", "pass", "password", "passphrase", "tv", "tokenValue"]

Basic censorship items - list definitions & initialiazations, etc. *

Static Private Readonly MAIN_SECURE_PROMPT_OPTIONS

MAIN_SECURE_PROMPT_OPTIONS: string[] = ["keyPassphrase", "password", "passphrase", "tokenValue", "user"]

Static Private mCensoredOptions

mCensoredOptions: Set<string> = new Set(this.DEFAULT_CENSORED_OPTIONS)

Static Private mConfig

mConfig: Config = null

Static Private mSchema

Singleton implementation of an internal reference to the schema

Accessors

Static CENSORED_OPTIONS

  • get CENSORED_OPTIONS(): string[]

Static DEFAULT_CENSORED_OPTIONS

  • get DEFAULT_CENSORED_OPTIONS(): string[]

Static SECURE_PROMPT_OPTIONS

  • get SECURE_PROMPT_OPTIONS(): string[]

Static profileSchemas

Methods

Static Private addCensoredOption

  • addCensoredOption(option: string): void

Static censorCLIArgs

  • censorCLIArgs(args: string[]): string[]

Static censorRawData

  • censorRawData(data: string, category?: string): string
  • Copy and censor any sensitive CLI arguments before logging/printing

    Parameters

    • data: string

      the data to censor

    • Default value category: string = ""

    Returns string

    • the censored data

Static censorYargsArguments

  • censorYargsArguments(args: Arguments): Arguments

Static Private handleSchema

Static isSecureValue

  • isSecureValue(prop: string): boolean

Static isSpecialValue

  • isSpecialValue(prop: string): boolean
  • Specifies whether a given property path (e.g. "profiles.lpar1.properties.host") is a special value or not. Special value: Refers to any value defined as secure in the schema definition. These values should be already masked by the application (and/or plugin) developer.

    Parameters

    • prop: string

      Property path to determine if it is a special value

    Returns boolean

    True - if the given property is to be treated as a special value; False - otherwise

Static setCensoredOptions

  • Generate and set the list of censored options. Attempt to source the censored options from the schema, config, and/or command being executed.

    Parameters

    • Optional censorOpts: ICensorOptions

      The objects to use to gather options that should be censored

    Returns void

Static setProfileSchemas

Generated using TypeDoc