https://github.com/lotfio/pssh

https://github.com/lotfio/pssh

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lotfio/pssh
• Owner: lotfio
• License: mit
• Created: 2020-12-13T21:26:31.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-23T13:37:42.000Z (almost 4 years ago)
• Last Synced: 2023-03-02T12:32:36.150Z (over 1 year ago)
• Language: PHP
• Size: 27.3 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  


    

    

    

    

    

    

    

  


    :key:  easier php ssh  :key:

  


### :fire: Introduction :

introduction

### :pushpin: Requirements :

- [SSH2 extension](https://www.php.net/manual/en/book.ssh2.php)

- PHP 7.2 or newer versions

- PHPUnit >= 8 (for testing purpose)

### :rocket: Installation & Use :

```php

composer require lotfio/pssh

```

### :pencil2: SSH:

```php

 'my-host',

    'auth'    =>  new Pssh\Auth\AuthUserPass('lotfio', 'secret')

];

$ssh  = new Pssh\Pssh($config);

echo $ssh->exec("date");  // Sat Nov 14 08:10:20 PM CET 2020

```

### :gear: confguration:

 - config keys

```php

  // additional details

  $config = [

    'host'      => 'server host',

    'port'      => 'server port || default 22',

    'auth'      => 'authentication method: AuthUserPass, AuthKeys, AuthHostBasedFile, AuthAgent or AuthNone.',

    'timeout'   => 'timeout when trying to connect',

    'methods'   => 'connection method checkout ssh2_connect form more details'

    'callbacks' => 'connection callbacks checkout ssh2_connect form more details'

  ];

```

 - **available SSH methods:**

    - `$ssh->exec(string $command):  string` execute a shell command.

    - `$ssh->fingerprint(int $type): string` get connection finger print.

    - `$ssh->methodsNegotiated(): array`     return an array of negotiated methods.

    - `$ssh->addPublicKey(): bool`           add a public key.

    - `$ssh->removePublicKey(): bool`        remove public key.

    - `$ssh->listPublicKeys(): array`        list public keys.

    - `$ssh->tunnel(): resource`             open an ssh tunnel.

 ### :pencil2: SFTP:

```php

 'my-host',

    'auth'    =>  new Pssh\Auth\AuthUserPass('lotfio', 'secret')

];

$ssh  = new Pssh\Pssh($config);

$sftp = new Pssh\Psftp($ssh);

$sftp->copyToServer('local-file', 'remote-file');

```

 - **available SSH methods:**

  - `$sftp->copyToServer(): bool`       copy a file from local to remote server.

  - `$sftp->copyFromServer(): bool`     copy a file from remote server to local.

  - `$sftp->chmod(): bool`              change mod file or dir.

  - `$sftp->mkdir(): bool`              make directory.

  - `$sftp->rmdir(): bool`              remove directory.

  - `$sftp->symlink(): bool`            create a symlink.

  - `$sftp->symlinkTarget(): string`    read symlink target.

  - `$sftp->symlinkStat(): array`       stating a symlink.

  - `$sftp->realpath(): string`         get realpath.

  - `$sftp->rename(): bool`             rename file.

  - `$sftp->stat(): array`              get file stat.

  - `$sftp->unlink(): bool`             delete file.

### :computer: Contributing

- Thank you for considering to contribute to ***Package***. All the contribution guidelines are mentioned [here](CONTRIBUTING.md).

### :page_with_curl: ChangeLog

- Here you can find the [ChangeLog](CHANGELOG.md).

### :beer: Support the development

- Share ***Package*** and lets get more stars and more contributors.

- If this project helped you reduce time to develop, you can give me a cup of coffee :) : **[Paypal](https://www.paypal.me/lotfio)**. 💖

### :clipboard: License

- ***Package*** is an open-source software licensed under the [MIT license](LICENSE).