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

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

// A complete overview of the file format can be found here
// https://man.openbsd.org/OpenBSD-current/man5/ssh_config.5

//! # ssh_config
//!
//! A crate to parse OpenBSD ssh_config files
//!
//! ## Usage
//!
//! Using this crate involves parsing a ssh_config file and querying the resulting
//! `SSHConfig` object for host definitions
//!
//! ```
//! # fn test() -> Result<(), ssh_config::Error> {
//! use ssh_config::SSHConfig;
//!
//! let config = SSHConfig::parse_str(r#"
//! Host test-host
//!   Port 22
//!   Username user
//! "#)?;
//!
//! let host_settings = config.query("test-host");
//! assert_eq!(host_settings["Port"], "22");
//! assert_eq!(host_settings["Username"], "User");
//!
//! # Ok(())
//! # }
//! ```

#![deny(warnings)]

mod pattern;
mod parser;
mod error;
mod config;

pub use error::Error;
pub use config::*;
pub use pattern::Pattern;