Home > PHP > Function > SSH2 > ssh2_publickey_add()

ssh2_publickey_add()

ssh2_publickey_add - Add an authorized publickey

Syntax

bool ssh2_publickey_add (resource $pkey, string $algoname, string $blob, bool $overwrite, array $attributes)

Arguments

  • pkey - Publickey Subsystem resource created by ssh2_publickey_init().
  • algoname - Publickey algorithm (e.g.): ssh-dss, ssh-rsa
  • blob - Publickey blob as raw binary data
  • overwrite - If the specified key already exists, should it be overwritten?
  • attributes - Associative array of attributes to assign to this public key. Refer to ietf-secsh-publickey-subsystem for a list of supported attributes. To mark an attribute as mandatory, precede its name with an asterisk. If the server is unable to support an attribute marked mandatory, it will abort the add process.

Description

Version

PHP PECL ssh2 >= 0.10

Return value

Returns TRUE on success or FALSE on failure.