# node-ssh-agent

**Repository Path**: mirrors_arekinath/node-ssh-agent

## Basic Information

- **Project Name**: node-ssh-agent
- **Description**: Node.js client library for interacting with the OpenSSH Agent
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

node-ssh-agent is a client binding to the SSH Agent protocol, written in "pure"
node.js.  For now, the operations supported are "list keys" and "sign data"
(which in SSH parlance is `requestIdentities` and `sign`.

## Usage

    var SSHAgentClient = require('ssh-agent');

    var client = new SSHAgentClient();
    var data = new Buffer('Hello World');

    // Try to sign data with an RSA key (will generate
    // an RSA-SHA1 signature).
    client.requestIdentities(function(err, keys) {
      var key = null;
      for (var i = 0; i < keys.length; i++) {
        if (keys[i].type === 'ssh-rsa') {
          key = keys[i];
          break;
        }
      }
      if (!key)
        return;

      client.sign(key, data, function(err, signature) {
        console.log('Signature: ' + signature.signature);
      });
    });


## Installation

    npm install ssh-agent

## License

MIT.

## Bugs

See <https://github.com/mcavage/node-ssh-agent/issues>.