Page MenuHomePhabricator
Diviner Phabricator Tech Docs PassphraseSSHPrivateKeyCredentialType

abstract class PassphraseSSHPrivateKeyCredentialType
Phabricator Technical Documentation (Passphrase)

This class is not documented.

Tasks

Managing Encryption Passwords

  • public function shouldShowPasswordField() — Return true to show an additional "Password" field. This is used by SSH credentials to strip passwords off private keys.
  • public function getPasswordLabel() — Return the label for the password field, if one is shown.
  • public function requiresPassword($secret) — Return true if the provided credential requires a password to decrypt.
  • public function decryptSecret($secret, $password) — Return the decrypted credential secret, or `null` if the password does not decrypt the credential.

Other Methods

Methods

abstract public function getCredentialType()
Inherited

This method is not documented.
Return
wild

final public function getProvidesType()

This method is not documented.
Return
wild

abstract public function getCredentialTypeName()
Inherited

This method is not documented.
Return
wild

abstract public function getCredentialTypeDescription()
Inherited

This method is not documented.
Return
wild

abstract public function getSecretLabel()
Inherited

This method is not documented.
Return
wild

public function newSecretControl()
Inherited

This method is not documented.
Return
wild

public static function getAllTypes()
Inherited

This method is not documented.
Return
wild

public static function getAllCreateableTypes()
Inherited

This method is not documented.
Return
wild

public static function getAllProvidesTypes()
Inherited

This method is not documented.
Return
wild

public static function getTypeByConstant($constant)
Inherited

This method is not documented.
Parameters
$constant
Return
wild

public function isCreateable()
Inherited

PassphraseCredentialType

Can users create new credentials of this type?

Return
boolTrue if new credentials of this type can be created.

public function didInitializeNewCredential($actor, $credential)
Inherited

This method is not documented.
Parameters
PhabricatorUser$actor
PassphraseCredential$credential
Return
wild

public function hasPublicKey()

This method is not documented.
Return
wild

public function getPublicKey($viewer, $credential)

This method is not documented.
Parameters
PhabricatorUser$viewer
PassphraseCredential$credential
Return
wild

public function shouldShowPasswordField()
Inherited

PassphraseCredentialType

Return true to show an additional "Password" field. This is used by SSH credentials to strip passwords off private keys.

Return
boolTrue if a password field should be shown to the user.

public function getPasswordLabel()
Inherited

PassphraseCredentialType

Return the label for the password field, if one is shown.

Return
stringHuman-readable field label.

public function requiresPassword($secret)
Inherited

PassphraseCredentialType

Return true if the provided credential requires a password to decrypt.

Parameters
PhutilOpaqueEnvelope$secretCredential secret value.
Return
boolTrue if the credential needs a password.

public function decryptSecret($secret, $password)
Inherited

PassphraseCredentialType

Return the decrypted credential secret, or null if the password does not decrypt the credential.

Parameters
PhutilOpaqueEnvelope$secretCredential secret value.
PhutilOpaqueEnvelope$passwordCredential password.
Return
1

public function shouldRequireUsername()
Inherited

This method is not documented.
Return
wild