ssh2_publickey_add
PHP function
Edit on GitHub ✎
(PECL ssh2 >= 0.10)
Add an authorized publickey
Description
ssh2_publickey_add(resource $pkey, string $algoname, string $blob, bool $overwrite = false, [array $attributes]): bool
Publickey
Parameters
pkeyPublickey Subsystem resource created by
ssh2_publickey_init().algonamePublickey algorithm (e.g.): ssh-dss, ssh-rsa
blobPublickey blob as raw binary data
overwriteIf the specified key already exists, should it be overwritten?
attributesAssociative 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.
Return Values
Success
Examples
Adding a publickey with ssh2_publickey_add()
php
<?php
$ssh2 = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($ssh2, 'jdoe', 'password');
$pkey = ssh2_publickey_init($ssh2);
$keyblob = base64_decode('
AAAAB3NzaC1yc2EAAAABIwAAAIEA5HVt6VqSGd5PTrLRdjNONxXH1tVFGn0
Bd26BF0aCP9qyJRlvdJ3j4WBeX4ZmrveGrjMgkseSYc4xZ26sDHwfL351xj
zaLpipu\BGRrw17mWVBhuCExo476ri5tQFzbTc54VEHYckxQ16CjSTibI5X
69GmnYC9PNqEYq/1TP+HF10=');
ssh2_publickey_add($pkey, 'ssh-rsa', $keyblob, false, array('comment'=>"John's Key"));
?>