forked from toolshed/abra
chore: vendor
This commit is contained in:
201
vendor/github.com/skeema/knownhosts/LICENSE
generated
vendored
Normal file
201
vendor/github.com/skeema/knownhosts/LICENSE
generated
vendored
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
13
vendor/github.com/skeema/knownhosts/NOTICE
generated
vendored
Normal file
13
vendor/github.com/skeema/knownhosts/NOTICE
generated
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
Copyright 2024 Skeema LLC and the Skeema Knownhosts authors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
117
vendor/github.com/skeema/knownhosts/README.md
generated
vendored
Normal file
117
vendor/github.com/skeema/knownhosts/README.md
generated
vendored
Normal file
@ -0,0 +1,117 @@
|
||||
# knownhosts: enhanced Golang SSH known_hosts management
|
||||
|
||||
[](https://github.com/skeema/knownhosts/actions)
|
||||
[](https://pkg.go.dev/github.com/skeema/knownhosts)
|
||||
|
||||
|
||||
> This repo is brought to you by [Skeema](https://github.com/skeema/skeema), a
|
||||
> declarative pure-SQL schema management system for MySQL and MariaDB. Our
|
||||
> premium products include extensive [SSH tunnel](https://www.skeema.io/docs/options/#ssh)
|
||||
> functionality, which internally makes use of this package.
|
||||
|
||||
Go provides excellent functionality for OpenSSH known_hosts files in its
|
||||
external package [golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts).
|
||||
However, that package is somewhat low-level, making it difficult to implement full known_hosts management similar to command-line `ssh`'s behavior for `StrictHostKeyChecking=no` configuration.
|
||||
|
||||
This repo ([github.com/skeema/knownhosts](https://github.com/skeema/knownhosts)) is a thin wrapper package around [golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts), adding the following functionality:
|
||||
|
||||
* Look up known_hosts public keys for any given host
|
||||
* Auto-populate ssh.ClientConfig.HostKeyAlgorithms easily based on known_hosts, providing a solution for [golang/go#29286](https://github.com/golang/go/issues/29286)
|
||||
* Write new known_hosts entries to an io.Writer
|
||||
* Properly format/normalize new known_hosts entries containing ipv6 addresses, providing a solution for [golang/go#53463](https://github.com/golang/go/issues/53463)
|
||||
* Determine if an ssh.HostKeyCallback's error corresponds to a host whose key has changed (indicating potential MitM attack) vs a host that just isn't known yet
|
||||
|
||||
## How host key lookup works
|
||||
|
||||
Although [golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts) doesn't directly expose a way to query its known_host map, we use a subtle trick to do so: invoke the HostKeyCallback with a valid host but a bogus key. The resulting KeyError allows us to determine which public keys are actually present for that host.
|
||||
|
||||
By using this technique, [github.com/skeema/knownhosts](https://github.com/skeema/knownhosts) doesn't need to duplicate or re-implement any of the actual known_hosts management from [golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts).
|
||||
|
||||
## Populating ssh.ClientConfig.HostKeyAlgorithms based on known_hosts
|
||||
|
||||
Hosts often have multiple public keys, each of a different type (algorithm). This can be [problematic](https://github.com/golang/go/issues/29286) in [golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts): if a host's first public key is *not* in known_hosts, but a key of a different type *is*, the HostKeyCallback returns an error. The solution is to populate `ssh.ClientConfig.HostKeyAlgorithms` based on the algorithms of the known_hosts entries for that host, but
|
||||
[golang.org/x/crypto/ssh/knownhosts](https://pkg.go.dev/golang.org/x/crypto/ssh/knownhosts)
|
||||
does not provide an obvious way to do so.
|
||||
|
||||
This package uses its host key lookup trick in order to make ssh.ClientConfig.HostKeyAlgorithms easy to populate:
|
||||
|
||||
```golang
|
||||
import (
|
||||
"golang.org/x/crypto/ssh"
|
||||
"github.com/skeema/knownhosts"
|
||||
)
|
||||
|
||||
func sshConfigForHost(hostWithPort string) (*ssh.ClientConfig, error) {
|
||||
kh, err := knownhosts.New("/home/myuser/.ssh/known_hosts")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
config := &ssh.ClientConfig{
|
||||
User: "myuser",
|
||||
Auth: []ssh.AuthMethod{ /* ... */ },
|
||||
HostKeyCallback: kh.HostKeyCallback(), // or, equivalently, use ssh.HostKeyCallback(kh)
|
||||
HostKeyAlgorithms: kh.HostKeyAlgorithms(hostWithPort),
|
||||
}
|
||||
return config, nil
|
||||
}
|
||||
```
|
||||
|
||||
## Writing new known_hosts entries
|
||||
|
||||
If you wish to mimic the behavior of OpenSSH's `StrictHostKeyChecking=no` or `StrictHostKeyChecking=ask`, this package provides a few functions to simplify this task. For example:
|
||||
|
||||
```golang
|
||||
sshHost := "yourserver.com:22"
|
||||
khPath := "/home/myuser/.ssh/known_hosts"
|
||||
kh, err := knownhosts.New(khPath)
|
||||
if err != nil {
|
||||
log.Fatal("Failed to read known_hosts: ", err)
|
||||
}
|
||||
|
||||
// Create a custom permissive hostkey callback which still errors on hosts
|
||||
// with changed keys, but allows unknown hosts and adds them to known_hosts
|
||||
cb := ssh.HostKeyCallback(func(hostname string, remote net.Addr, key ssh.PublicKey) error {
|
||||
err := kh(hostname, remote, key)
|
||||
if knownhosts.IsHostKeyChanged(err) {
|
||||
return fmt.Errorf("REMOTE HOST IDENTIFICATION HAS CHANGED for host %s! This may indicate a MitM attack.", hostname)
|
||||
} else if knownhosts.IsHostUnknown(err) {
|
||||
f, ferr := os.OpenFile(khPath, os.O_APPEND|os.O_WRONLY, 0600)
|
||||
if ferr == nil {
|
||||
defer f.Close()
|
||||
ferr = knownhosts.WriteKnownHost(f, hostname, remote, key)
|
||||
}
|
||||
if ferr == nil {
|
||||
log.Printf("Added host %s to known_hosts\n", hostname)
|
||||
} else {
|
||||
log.Printf("Failed to add host %s to known_hosts: %v\n", hostname, ferr)
|
||||
}
|
||||
return nil // permit previously-unknown hosts (warning: may be insecure)
|
||||
}
|
||||
return err
|
||||
})
|
||||
|
||||
config := &ssh.ClientConfig{
|
||||
User: "myuser",
|
||||
Auth: []ssh.AuthMethod{ /* ... */ },
|
||||
HostKeyCallback: cb,
|
||||
HostKeyAlgorithms: kh.HostKeyAlgorithms(sshHost),
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
**Source code copyright 2024 Skeema LLC and the Skeema Knownhosts authors**
|
||||
|
||||
```text
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
192
vendor/github.com/skeema/knownhosts/knownhosts.go
generated
vendored
Normal file
192
vendor/github.com/skeema/knownhosts/knownhosts.go
generated
vendored
Normal file
@ -0,0 +1,192 @@
|
||||
// Package knownhosts is a thin wrapper around golang.org/x/crypto/ssh/knownhosts,
|
||||
// adding the ability to obtain the list of host key algorithms for a known host.
|
||||
package knownhosts
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/crypto/ssh"
|
||||
xknownhosts "golang.org/x/crypto/ssh/knownhosts"
|
||||
)
|
||||
|
||||
// HostKeyCallback wraps ssh.HostKeyCallback with an additional method to
|
||||
// perform host key algorithm lookups from the known_hosts entries.
|
||||
type HostKeyCallback ssh.HostKeyCallback
|
||||
|
||||
// New creates a host key callback from the given OpenSSH host key files. The
|
||||
// returned value may be used in ssh.ClientConfig.HostKeyCallback by casting it
|
||||
// to ssh.HostKeyCallback, or using its HostKeyCallback method. Otherwise, it
|
||||
// operates the same as the New function in golang.org/x/crypto/ssh/knownhosts.
|
||||
func New(files ...string) (HostKeyCallback, error) {
|
||||
cb, err := xknownhosts.New(files...)
|
||||
return HostKeyCallback(cb), err
|
||||
}
|
||||
|
||||
// HostKeyCallback simply casts the receiver back to ssh.HostKeyCallback, for
|
||||
// use in ssh.ClientConfig.HostKeyCallback.
|
||||
func (hkcb HostKeyCallback) HostKeyCallback() ssh.HostKeyCallback {
|
||||
return ssh.HostKeyCallback(hkcb)
|
||||
}
|
||||
|
||||
// HostKeys returns a slice of known host public keys for the supplied host:port
|
||||
// found in the known_hosts file(s), or an empty slice if the host is not
|
||||
// already known. For hosts that have multiple known_hosts entries (for
|
||||
// different key types), the result will be sorted by known_hosts filename and
|
||||
// line number.
|
||||
func (hkcb HostKeyCallback) HostKeys(hostWithPort string) (keys []ssh.PublicKey) {
|
||||
var keyErr *xknownhosts.KeyError
|
||||
placeholderAddr := &net.TCPAddr{IP: []byte{0, 0, 0, 0}}
|
||||
placeholderPubKey := &fakePublicKey{}
|
||||
var kkeys []xknownhosts.KnownKey
|
||||
if hkcbErr := hkcb(hostWithPort, placeholderAddr, placeholderPubKey); errors.As(hkcbErr, &keyErr) {
|
||||
kkeys = append(kkeys, keyErr.Want...)
|
||||
knownKeyLess := func(i, j int) bool {
|
||||
if kkeys[i].Filename < kkeys[j].Filename {
|
||||
return true
|
||||
}
|
||||
return (kkeys[i].Filename == kkeys[j].Filename && kkeys[i].Line < kkeys[j].Line)
|
||||
}
|
||||
sort.Slice(kkeys, knownKeyLess)
|
||||
keys = make([]ssh.PublicKey, len(kkeys))
|
||||
for n := range kkeys {
|
||||
keys[n] = kkeys[n].Key
|
||||
}
|
||||
}
|
||||
return keys
|
||||
}
|
||||
|
||||
// HostKeyAlgorithms returns a slice of host key algorithms for the supplied
|
||||
// host:port found in the known_hosts file(s), or an empty slice if the host
|
||||
// is not already known. The result may be used in ssh.ClientConfig's
|
||||
// HostKeyAlgorithms field, either as-is or after filtering (if you wish to
|
||||
// ignore or prefer particular algorithms). For hosts that have multiple
|
||||
// known_hosts entries (for different key types), the result will be sorted by
|
||||
// known_hosts filename and line number.
|
||||
func (hkcb HostKeyCallback) HostKeyAlgorithms(hostWithPort string) (algos []string) {
|
||||
// We ensure that algos never contains duplicates. This is done for robustness
|
||||
// even though currently golang.org/x/crypto/ssh/knownhosts never exposes
|
||||
// multiple keys of the same type. This way our behavior here is unaffected
|
||||
// even if https://github.com/golang/go/issues/28870 is implemented, for
|
||||
// example by https://github.com/golang/crypto/pull/254.
|
||||
hostKeys := hkcb.HostKeys(hostWithPort)
|
||||
seen := make(map[string]struct{}, len(hostKeys))
|
||||
addAlgo := func(typ string) {
|
||||
if _, already := seen[typ]; !already {
|
||||
algos = append(algos, typ)
|
||||
seen[typ] = struct{}{}
|
||||
}
|
||||
}
|
||||
for _, key := range hostKeys {
|
||||
typ := key.Type()
|
||||
if typ == ssh.KeyAlgoRSA {
|
||||
// KeyAlgoRSASHA256 and KeyAlgoRSASHA512 are only public key algorithms,
|
||||
// not public key formats, so they can't appear as a PublicKey.Type.
|
||||
// The corresponding PublicKey.Type is KeyAlgoRSA. See RFC 8332, Section 2.
|
||||
addAlgo(ssh.KeyAlgoRSASHA512)
|
||||
addAlgo(ssh.KeyAlgoRSASHA256)
|
||||
}
|
||||
addAlgo(typ)
|
||||
}
|
||||
return algos
|
||||
}
|
||||
|
||||
// HostKeyAlgorithms is a convenience function for performing host key algorithm
|
||||
// lookups on an ssh.HostKeyCallback directly. It is intended for use in code
|
||||
// paths that stay with the New method of golang.org/x/crypto/ssh/knownhosts
|
||||
// rather than this package's New method.
|
||||
func HostKeyAlgorithms(cb ssh.HostKeyCallback, hostWithPort string) []string {
|
||||
return HostKeyCallback(cb).HostKeyAlgorithms(hostWithPort)
|
||||
}
|
||||
|
||||
// IsHostKeyChanged returns a boolean indicating whether the error indicates
|
||||
// the host key has changed. It is intended to be called on the error returned
|
||||
// from invoking a HostKeyCallback to check whether an SSH host is known.
|
||||
func IsHostKeyChanged(err error) bool {
|
||||
var keyErr *xknownhosts.KeyError
|
||||
return errors.As(err, &keyErr) && len(keyErr.Want) > 0
|
||||
}
|
||||
|
||||
// IsHostUnknown returns a boolean indicating whether the error represents an
|
||||
// unknown host. It is intended to be called on the error returned from invoking
|
||||
// a HostKeyCallback to check whether an SSH host is known.
|
||||
func IsHostUnknown(err error) bool {
|
||||
var keyErr *xknownhosts.KeyError
|
||||
return errors.As(err, &keyErr) && len(keyErr.Want) == 0
|
||||
}
|
||||
|
||||
// Normalize normalizes an address into the form used in known_hosts. This
|
||||
// implementation includes a fix for https://github.com/golang/go/issues/53463
|
||||
// and will omit brackets around ipv6 addresses on standard port 22.
|
||||
func Normalize(address string) string {
|
||||
host, port, err := net.SplitHostPort(address)
|
||||
if err != nil {
|
||||
host = address
|
||||
port = "22"
|
||||
}
|
||||
entry := host
|
||||
if port != "22" {
|
||||
entry = "[" + entry + "]:" + port
|
||||
} else if strings.HasPrefix(host, "[") && strings.HasSuffix(host, "]") {
|
||||
entry = entry[1 : len(entry)-1]
|
||||
}
|
||||
return entry
|
||||
}
|
||||
|
||||
// Line returns a line to append to the known_hosts files. This implementation
|
||||
// uses the local patched implementation of Normalize in order to solve
|
||||
// https://github.com/golang/go/issues/53463.
|
||||
func Line(addresses []string, key ssh.PublicKey) string {
|
||||
var trimmed []string
|
||||
for _, a := range addresses {
|
||||
trimmed = append(trimmed, Normalize(a))
|
||||
}
|
||||
|
||||
return strings.Join([]string{
|
||||
strings.Join(trimmed, ","),
|
||||
key.Type(),
|
||||
base64.StdEncoding.EncodeToString(key.Marshal()),
|
||||
}, " ")
|
||||
}
|
||||
|
||||
// WriteKnownHost writes a known_hosts line to writer for the supplied hostname,
|
||||
// remote, and key. This is useful when writing a custom hostkey callback which
|
||||
// wraps a callback obtained from knownhosts.New to provide additional
|
||||
// known_hosts management functionality. The hostname, remote, and key typically
|
||||
// correspond to the callback's args.
|
||||
func WriteKnownHost(w io.Writer, hostname string, remote net.Addr, key ssh.PublicKey) error {
|
||||
// Always include hostname; only also include remote if it isn't a zero value
|
||||
// and doesn't normalize to the same string as hostname.
|
||||
hostnameNormalized := Normalize(hostname)
|
||||
if strings.ContainsAny(hostnameNormalized, "\t ") {
|
||||
return fmt.Errorf("knownhosts: hostname '%s' contains spaces", hostnameNormalized)
|
||||
}
|
||||
addresses := []string{hostnameNormalized}
|
||||
remoteStrNormalized := Normalize(remote.String())
|
||||
if remoteStrNormalized != "[0.0.0.0]:0" && remoteStrNormalized != hostnameNormalized &&
|
||||
!strings.ContainsAny(remoteStrNormalized, "\t ") {
|
||||
addresses = append(addresses, remoteStrNormalized)
|
||||
}
|
||||
line := Line(addresses, key) + "\n"
|
||||
_, err := w.Write([]byte(line))
|
||||
return err
|
||||
}
|
||||
|
||||
// fakePublicKey is used as part of the work-around for
|
||||
// https://github.com/golang/go/issues/29286
|
||||
type fakePublicKey struct{}
|
||||
|
||||
func (fakePublicKey) Type() string {
|
||||
return "fake-public-key"
|
||||
}
|
||||
func (fakePublicKey) Marshal() []byte {
|
||||
return []byte("fake public key")
|
||||
}
|
||||
func (fakePublicKey) Verify(_ []byte, _ *ssh.Signature) error {
|
||||
return errors.New("Verify called on placeholder key")
|
||||
}
|
Reference in New Issue
Block a user