https://github.com/wiktor-k/ssh-agent-lib
A collection of types for writing custom SSH agents.
https://github.com/wiktor-k/ssh-agent-lib
agent rust ssh
Last synced: 12 months ago
JSON representation
A collection of types for writing custom SSH agents.
- Host: GitHub
- URL: https://github.com/wiktor-k/ssh-agent-lib
- Owner: wiktor-k
- License: apache-2.0
- Created: 2022-01-21T11:50:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-20T14:48:34.000Z (over 1 year ago)
- Last Synced: 2025-06-15T06:07:41.531Z (about 1 year ago)
- Topics: agent, rust, ssh
- Language: Rust
- Homepage: https://crates.io/crates/ssh-agent-lib
- Size: 490 KB
- Stars: 27
- Watchers: 3
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ssh-agent-lib
[](https://github.com/wiktor-k/ssh-agent-lib/actions/workflows/rust.yml)
[](https://crates.io/crates/ssh-agent-lib)
A collection of types for writing custom SSH agents and connecting to existing ones.
The types in this crate closely follow the [SSH Agent Protocol Internet Draft](https://datatracker.ietf.org/doc/html/draft-miller-ssh-agent) specification and can be used to utilize remote keys not supported by the default OpenSSH agent.
## Examples
The following examples show a sample agent and a sample client.
For more elaborate example see the `examples` directory or [crates using `ssh-agent-lib`](https://crates.io/crates/ssh-agent-lib/reverse_dependencies).
### Agent
The following example starts listening on a socket and processing requests.
On Unix it uses `ssh-agent.sock` Unix domain socket while on Windows it uses a named pipe `\\.\pipe\agent`.
```rust,no_run
#[cfg(not(windows))]
use tokio::net::UnixListener as Listener;
#[cfg(windows)]
use ssh_agent_lib::agent::NamedPipeListener as Listener;
use ssh_agent_lib::error::AgentError;
use ssh_agent_lib::agent::{Session, listen};
use ssh_agent_lib::proto::{Identity, SignRequest};
use ssh_key::{Algorithm, Signature};
#[derive(Default, Clone)]
struct MyAgent;
#[ssh_agent_lib::async_trait]
impl Session for MyAgent {
async fn request_identities(&mut self) -> Result, AgentError> {
Ok(vec![ /* public keys that this agent knows of */ ])
}
async fn sign(&mut self, request: SignRequest) -> Result {
// get the signature by signing `request.data`
let signature = vec![];
Ok(Signature::new(
Algorithm::new("algorithm").map_err(AgentError::other)?,
signature,
).map_err(AgentError::other)?)
}
}
#[tokio::main]
async fn main() -> Result<(), Box> {
#[cfg(not(windows))]
let socket = "ssh-agent.sock";
#[cfg(windows)]
let socket = r"\\.\pipe\agent";
let _ = std::fs::remove_file(socket); // remove the socket if exists
listen(Listener::bind(socket)?, MyAgent::default()).await?;
Ok(())
}
```
Now, point your OpenSSH client to this socket using `SSH_AUTH_SOCK` environment variable and it will transparently use the agent:
```sh
SSH_AUTH_SOCK=ssh-agent.sock ssh user@example.com
```
On Windows the path of the pipe has to be used:
```sh
SSH_AUTH_SOCK=\\.\pipe\agent ssh user@example.com
```
### Client
The following example connects to the agent pointed to by the `SSH_AUTH_SOCK` environment variable and prints identities (public keys) that the agent knows of:
```rust,no_run
use service_binding::Binding;
use ssh_agent_lib::client::connect;
#[tokio::main]
async fn main() -> Result<(), Box> {
#[cfg(unix)]
let mut client =
connect(Binding::FilePath(std::env::var("SSH_AUTH_SOCK")?.into()).try_into()?)?;
#[cfg(windows)]
let mut client =
connect(Binding::NamedPipe(std::env::var("SSH_AUTH_SOCK")?.into()).try_into()?)?;
eprintln!(
"Identities that this agent knows of: {:#?}",
client.request_identities().await?
);
Ok(())
}
```
## License
This project is licensed under either of:
- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
- [MIT license](https://opensource.org/licenses/MIT).
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
### Note
This library has been forked from [sekey/ssh-agent.rs](https://github.com/sekey/ssh-agent.rs) as the upstream seems not be maintained (at least as of 2022).
The library was previously licensed under MIT, however in [#36], we relicensed it to MIT/Apache 2.0.
Contributors gave their approval for relicensing [#36] [screenshot]
[#36]: https://github.com/wiktor-k/ssh-agent-lib/pull/36
[screenshot]: http://web.archive.org/web/20240408190456/https://github.com/wiktor-k/ssh-agent-lib/pull/36
What remains from the original library is considered minor and does not count for copyright assignment.