README
¶
OpenSSH config parser for golang
Parses the config usually found in ~/.ssh/config or /etc/ssh/ssh_config.
Only Host, HostName, User, Port, IdentityFile, HostKeyAlgorithms, ProxyCommand, LocalForward, RemoteForward and DynamicForward is implemented at
this point.
Usage
Example usage
package main
import (
"fmt"
"github.com/mikkeloscar/sshconfig"
)
func main() {
hosts, err := ParseSSHConfig("/path/to/ssh_config")
if err != nil {
fmt.Println(err)
}
for _, host := range hosts {
fmt.Printf("Hostname: %s", host.HostName)
}
}
LICENSE
Copyright (C) 2022 Mikkel Oscar Lyderik Larsen & Contributors
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DynamicForward ¶
DynamicForward defines a single dynamic port forward entry
func NewDynamicForward ¶
func NewDynamicForward(f string) (DynamicForward, error)
NewDynamicForward returns DForward object parsed from DynamicForward string
type Forward ¶
Forward defines a single port forward entry
func NewForward ¶
NewForward returns Forward object parsed from LocalForward or RemoteForward string
type SSHHost ¶
type SSHHost struct {
Host []string
HostName string
User string
Port int
ProxyCommand string
HostKeyAlgorithms string
IdentityFile string
LocalForwards []Forward
RemoteForwards []Forward
DynamicForwards []DynamicForward
}
SSHHost defines a single host entry in a ssh config
func MustParseSSHConfig ¶
MustParseSSHConfig must parse the SSH config given by path or it will panic Deprecated: Use MustParse instead.
func ParseSSHConfig ¶
ParseSSHConfig parses a SSH config given by path. Deprecated: Use Parse instead.
Source Files