File: README.md

package info (click to toggle)
rust-sshkeys 0.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 392 kB
  • sloc: makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,308 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
## sshkeys - Rust library for parsing OpenSSH public keys and certificates

[![Build Status](https://travis-ci.org/dnaeon/rust-sshkeys.svg?branch=master)](https://travis-ci.org/dnaeon/rust-sshkeys)
[![Docs](https://docs.rs/sshkeys/badge.svg)](https://docs.rs/sshkeys/)

The `sshkeys` crate is a Rust library, which provides types and methods for
parsing OpenSSH public keys and certificates.

In order to use this crate in your project, simply add the following to your
`Cargo.toml` file.

```toml
[dependencies]
sshkeys = "0.1.1"
```

## Tests

In order to test this crate locally, execute the following command.

```bash
$ cargo test
```

## Documentation

The `sshkeys` crate has documentation, which you can build and view locally.

```bash
$ cargo doc --open
```

## Examples

For examples on how to use this crate, please refer to the `examples` directory.

In order to run an example, simply execute the following command.

```bash
$ cargo run --example <example-name>
```

## Contributions

The `sshkeys` crate is hosted on [Github](https://github.com/dnaeon/rust-sshkeys).
Please contribute by reporting issues, suggesting features or by
sending patches using pull requests.

## License

This project is Open Source and licensed under the
[BSD License](http://opensource.org/licenses/BSD-2-Clause).