https://github.com/131/ssh-agent-js

https://github.com/131/ssh-agent-js

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/131/ssh-agent-js
• Owner: 131
• License: mit
• Created: 2015-08-07T03:46:35.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-09-16T20:22:08.000Z (over 6 years ago)
• Last Synced: 2025-11-27T10:46:23.662Z (7 months ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/131/ssh-agent-js.svg?branch=master)](https://travis-ci.org/131/ssh-agent-js)

[![Coverage Status](https://coveralls.io/repos/github/131/ssh-agent-js/badge.svg?branch=master)](https://coveralls.io/github/131/ssh-agent-js?branch=master)

[![Version](https://img.shields.io/npm/v/ssh-agent-js.svg)](https://www.npmjs.com/package/ssh-agent-js)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

[![Code style](https://img.shields.io/badge/code%2fstyle-ivs-green.svg)](https://www.npmjs.com/package/eslint-plugin-ivs)

# Motivation

A pure js drop-in replacement for ssh-agent.

This agent is a replacement for the ssh-agent program. This package includes both a **"server"** and **"client"** API. This library implements the official agent protocol and is compatible with all ssh clients (ssh & putty)

# Client API

## new Agent(socket)

## await agent.list_keys();

## await agent.add_key( privateKey [,  alias]);

## await agent.remove_key( pubkey ||  alias ||  fingerprint);

## await agent.remove_all_keys();

## await agent.sign( alias ||  fingerprint,  message);

# Credits

* [131](https://github.com/131)

* yks ssh-agent https://github.com/131/yks/blob/master/class/apis/ssh_agent.php

* https://tools.ietf.org/html/draft-miller-ssh-agent-00

* https://github.com/131/pageantbridge