parsing

Documentation

Overview

Copyright © 2024 Adam Presley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2024 Adam Presley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Variables
• func ExpandHomeDir(filePath string) string
• func GetSSHConfigHosts(reader io.Reader) ([]string, error)
• func GetSSHHost(reader io.Reader, hostKey string) (*ssh_config.Host, error)
• func OpenSSHConfigFile(fileName string) (fs.File, error)

Variables

var (
	DefaultSSHConfigFile string = filepath.Join(os.Getenv("HOME"), ".ssh", "config")
)

Functions

func ExpandHomeDir

func ExpandHomeDir(filePath string) string

func GetSSHConfigHosts

func GetSSHConfigHosts(reader io.Reader) ([]string, error)

GetSSHConfigHosts returns a string slice of all hosts names found in an SSH config file.

func GetSSHHost

func GetSSHHost(reader io.Reader, hostKey string) (*ssh_config.Host, error)

GetSSHHost returns a host entry from an SSH config file.

func OpenSSHConfigFile

func OpenSSHConfigFile(fileName string) (fs.File, error)

OpenSSHConfigFile returns a file handle to an SSH config file