mirror of
https://github.com/Luzifer/vault-openvpn.git
synced 2024-11-09 16:50:04 +00:00
Remove vendoring
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
parent
093801d21c
commit
260d4c2f7f
798 changed files with 0 additions and 334580 deletions
12
vendor/github.com/Luzifer/go-dhparam/.travis.yml
generated
vendored
12
vendor/github.com/Luzifer/go-dhparam/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8.x
|
|
||||||
- 1.9.x
|
|
||||||
- 1.10.x
|
|
||||||
- 1.11.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go vet
|
|
||||||
- go test -v -cover -timeout 1800s
|
|
3
vendor/github.com/Luzifer/go-dhparam/History.md
generated
vendored
3
vendor/github.com/Luzifer/go-dhparam/History.md
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
# 1.0.0 / 2018-10-08
|
|
||||||
|
|
||||||
* Initial version
|
|
202
vendor/github.com/Luzifer/go-dhparam/LICENSE
generated
vendored
202
vendor/github.com/Luzifer/go-dhparam/LICENSE
generated
vendored
|
@ -1,202 +0,0 @@
|
||||||
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 2018- Knut Ahlers <knut@ahlers.me>
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
9
vendor/github.com/Luzifer/go-dhparam/README.md
generated
vendored
9
vendor/github.com/Luzifer/go-dhparam/README.md
generated
vendored
|
@ -1,9 +0,0 @@
|
||||||
[![](https://badges.fyi/static/godoc/reference/5272B4)](https://godoc.org/github.com/Luzifer/go-dhparam)
|
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/Luzifer/go-dhparam)](https://goreportcard.com/report/github.com/Luzifer/go-dhparam)
|
|
||||||
![](https://badges.fyi/github/license/Luzifer/go-dhparam)
|
|
||||||
![](https://badges.fyi/github/latest-tag/Luzifer/go-dhparam)
|
|
||||||
[![](https://travis-ci.org/Luzifer/go-dhparam.svg?branch=master)](https://travis-ci.org/Luzifer/go-dhparam)
|
|
||||||
|
|
||||||
# Luzifer / go-dhparam
|
|
||||||
|
|
||||||
`go-dhparam` is a pure Golang implementation of the `openssl dhparam` generator no requiring any CGO bindings.
|
|
44
vendor/github.com/Luzifer/go-dhparam/dh.go
generated
vendored
44
vendor/github.com/Luzifer/go-dhparam/dh.go
generated
vendored
|
@ -1,44 +0,0 @@
|
||||||
package dhparam
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/asn1"
|
|
||||||
"encoding/pem"
|
|
||||||
"math/big"
|
|
||||||
|
|
||||||
"github.com/pkg/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DH contains a prime (P) and a generator (G) number representing the DH parameters
|
|
||||||
type DH struct {
|
|
||||||
P *big.Int
|
|
||||||
G int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Decode reads a DH parameters struct from its PEM data
|
|
||||||
func Decode(pemData []byte) (*DH, error) {
|
|
||||||
blk, _ := pem.Decode(pemData)
|
|
||||||
|
|
||||||
out := &DH{}
|
|
||||||
if _, err := asn1.Unmarshal(blk.Bytes, out); err != nil {
|
|
||||||
return nil, errors.Wrap(err, "Could not unmarshal ASN1")
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToPEM encodes the DH parameters using ASN1 and PEM encoding
|
|
||||||
func (d DH) ToPEM() ([]byte, error) {
|
|
||||||
data, err := asn1.Marshal(d)
|
|
||||||
if err != nil {
|
|
||||||
return nil, errors.Wrap(err, "Unable to marshal ASN1 data")
|
|
||||||
}
|
|
||||||
|
|
||||||
buf := new(bytes.Buffer)
|
|
||||||
err = pem.Encode(buf, &pem.Block{
|
|
||||||
Type: pemHeader,
|
|
||||||
Bytes: data,
|
|
||||||
})
|
|
||||||
|
|
||||||
return buf.Bytes(), err
|
|
||||||
}
|
|
163
vendor/github.com/Luzifer/go-dhparam/generator.go
generated
vendored
163
vendor/github.com/Luzifer/go-dhparam/generator.go
generated
vendored
|
@ -1,163 +0,0 @@
|
||||||
package dhparam
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/rand"
|
|
||||||
"math/big"
|
|
||||||
|
|
||||||
"github.com/pkg/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
const pemHeader = "DH PARAMETERS"
|
|
||||||
|
|
||||||
// GeneratorResult is a type of results sent to the GeneratorCallback function
|
|
||||||
type GeneratorResult uint
|
|
||||||
|
|
||||||
const (
|
|
||||||
// GeneratorFoundPossiblePrime signals a possible (non-verified) prime number was found (OpenSSL: ".")
|
|
||||||
GeneratorFoundPossiblePrime GeneratorResult = iota
|
|
||||||
// GeneratorFirstConfirmation signals the prime number itself was verified but is not yet considered "safe" (OpenSSL: "+")
|
|
||||||
GeneratorFirstConfirmation
|
|
||||||
// GeneratorSafePrimeFound signals the prime number now is considered "safe" (OpenSSL: "*")
|
|
||||||
GeneratorSafePrimeFound
|
|
||||||
)
|
|
||||||
|
|
||||||
// Generator is the generator number to use when determining the prime number
|
|
||||||
type Generator int
|
|
||||||
|
|
||||||
const (
|
|
||||||
// GeneratorTwo uses a generator 2
|
|
||||||
GeneratorTwo Generator = 2
|
|
||||||
// GeneratorFive uses a generator 5
|
|
||||||
GeneratorFive = 5
|
|
||||||
)
|
|
||||||
|
|
||||||
// GeneratorCallback is a type of function to receive GeneratorResults while the prime number is determined
|
|
||||||
type GeneratorCallback func(r GeneratorResult)
|
|
||||||
|
|
||||||
func nullCallback(r GeneratorResult) {}
|
|
||||||
|
|
||||||
// Generate determines a prime number according to the generator having the specified number of bits
|
|
||||||
//
|
|
||||||
// In OpenSSL defined generators are 2 and 5. Others are supported but the verification is not supported in an extend as with generators 2 and 5.
|
|
||||||
// The bit size should be adjusted to be high enough for the current requirements. Also you should keep
|
|
||||||
// in mind the higher the bitsize, the longer the generation might take.
|
|
||||||
func Generate(bits int, generator Generator, cb GeneratorCallback) (*DH, error) {
|
|
||||||
var (
|
|
||||||
err error
|
|
||||||
padd, rem int64
|
|
||||||
prime *big.Int
|
|
||||||
)
|
|
||||||
|
|
||||||
if cb == nil {
|
|
||||||
cb = nullCallback
|
|
||||||
}
|
|
||||||
|
|
||||||
switch generator {
|
|
||||||
case 2:
|
|
||||||
padd, rem = 24, 11
|
|
||||||
case 5:
|
|
||||||
padd, rem = 10, 3
|
|
||||||
default:
|
|
||||||
padd, rem = 2, 1
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
if prime, err = genPrime(bits, big.NewInt(padd), big.NewInt(rem)); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if prime.BitLen() > bits {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
t := new(big.Int)
|
|
||||||
t.Rsh(prime, 1)
|
|
||||||
|
|
||||||
cb(GeneratorFoundPossiblePrime)
|
|
||||||
|
|
||||||
if prime.ProbablyPrime(0) {
|
|
||||||
cb(GeneratorFirstConfirmation)
|
|
||||||
} else {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if t.ProbablyPrime(0) {
|
|
||||||
cb(GeneratorSafePrimeFound)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &DH{
|
|
||||||
P: prime,
|
|
||||||
G: int(generator),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func genPrime(bits int, padd, rem *big.Int) (*big.Int, error) {
|
|
||||||
var (
|
|
||||||
err error
|
|
||||||
p = new(big.Int)
|
|
||||||
qadd = new(big.Int)
|
|
||||||
q = new(big.Int)
|
|
||||||
t1 = new(big.Int)
|
|
||||||
)
|
|
||||||
|
|
||||||
bits--
|
|
||||||
|
|
||||||
qadd.Rsh(padd, 1)
|
|
||||||
|
|
||||||
if q, err = genRand(bits); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
t1.Mod(q, qadd)
|
|
||||||
q.Sub(q, t1)
|
|
||||||
|
|
||||||
t1.Rsh(rem, 1)
|
|
||||||
q.Add(q, t1)
|
|
||||||
|
|
||||||
p.Lsh(q, 1)
|
|
||||||
p.Add(p, big.NewInt(1))
|
|
||||||
|
|
||||||
for !mightBePrime(p) || !mightBePrime(q) {
|
|
||||||
p.Add(p, padd)
|
|
||||||
q.Add(q, qadd)
|
|
||||||
}
|
|
||||||
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func mightBePrime(i *big.Int) bool {
|
|
||||||
m := new(big.Int)
|
|
||||||
for _, p := range quickTestPrimes {
|
|
||||||
if m.Mod(i, big.NewInt(p)).Int64() == 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
func genRand(bits int) (*big.Int, error) {
|
|
||||||
bytes := (bits + 7) / 8
|
|
||||||
bit := (bits - 1) % 8
|
|
||||||
mask := 0xff << uint(bit+1)
|
|
||||||
|
|
||||||
buf := make([]byte, bytes)
|
|
||||||
if _, err := rand.Read(buf); err != nil {
|
|
||||||
return nil, errors.Wrap(err, "Unable to read random")
|
|
||||||
}
|
|
||||||
|
|
||||||
if bit == 0 {
|
|
||||||
buf[0] = 1
|
|
||||||
buf[1] |= 0x80
|
|
||||||
} else {
|
|
||||||
buf[0] |= (3 << uint(bit-1))
|
|
||||||
}
|
|
||||||
|
|
||||||
buf[0] &= byte(^mask)
|
|
||||||
|
|
||||||
buf[bytes-1] |= 1
|
|
||||||
|
|
||||||
r := new(big.Int)
|
|
||||||
return r.SetBytes(buf), nil
|
|
||||||
}
|
|
261
vendor/github.com/Luzifer/go-dhparam/primes.go
generated
vendored
261
vendor/github.com/Luzifer/go-dhparam/primes.go
generated
vendored
|
@ -1,261 +0,0 @@
|
||||||
package dhparam
|
|
||||||
|
|
||||||
var quickTestPrimes = []int64{
|
|
||||||
// 2, // two is not checked in openssl code
|
|
||||||
3, 5, 7, 11, 13, 17, 19,
|
|
||||||
23, 29, 31, 37, 41, 43, 47, 53,
|
|
||||||
59, 61, 67, 71, 73, 79, 83, 89,
|
|
||||||
97, 101, 103, 107, 109, 113, 127, 131,
|
|
||||||
137, 139, 149, 151, 157, 163, 167, 173,
|
|
||||||
179, 181, 191, 193, 197, 199, 211, 223,
|
|
||||||
227, 229, 233, 239, 241, 251, 257, 263,
|
|
||||||
269, 271, 277, 281, 283, 293, 307, 311,
|
|
||||||
313, 317, 331, 337, 347, 349, 353, 359,
|
|
||||||
367, 373, 379, 383, 389, 397, 401, 409,
|
|
||||||
419, 421, 431, 433, 439, 443, 449, 457,
|
|
||||||
461, 463, 467, 479, 487, 491, 499, 503,
|
|
||||||
509, 521, 523, 541, 547, 557, 563, 569,
|
|
||||||
571, 577, 587, 593, 599, 601, 607, 613,
|
|
||||||
617, 619, 631, 641, 643, 647, 653, 659,
|
|
||||||
661, 673, 677, 683, 691, 701, 709, 719,
|
|
||||||
727, 733, 739, 743, 751, 757, 761, 769,
|
|
||||||
773, 787, 797, 809, 811, 821, 823, 827,
|
|
||||||
829, 839, 853, 857, 859, 863, 877, 881,
|
|
||||||
883, 887, 907, 911, 919, 929, 937, 941,
|
|
||||||
947, 953, 967, 971, 977, 983, 991, 997,
|
|
||||||
1009, 1013, 1019, 1021, 1031, 1033, 1039, 1049,
|
|
||||||
1051, 1061, 1063, 1069, 1087, 1091, 1093, 1097,
|
|
||||||
1103, 1109, 1117, 1123, 1129, 1151, 1153, 1163,
|
|
||||||
1171, 1181, 1187, 1193, 1201, 1213, 1217, 1223,
|
|
||||||
1229, 1231, 1237, 1249, 1259, 1277, 1279, 1283,
|
|
||||||
1289, 1291, 1297, 1301, 1303, 1307, 1319, 1321,
|
|
||||||
1327, 1361, 1367, 1373, 1381, 1399, 1409, 1423,
|
|
||||||
1427, 1429, 1433, 1439, 1447, 1451, 1453, 1459,
|
|
||||||
1471, 1481, 1483, 1487, 1489, 1493, 1499, 1511,
|
|
||||||
1523, 1531, 1543, 1549, 1553, 1559, 1567, 1571,
|
|
||||||
1579, 1583, 1597, 1601, 1607, 1609, 1613, 1619,
|
|
||||||
1621, 1627, 1637, 1657, 1663, 1667, 1669, 1693,
|
|
||||||
1697, 1699, 1709, 1721, 1723, 1733, 1741, 1747,
|
|
||||||
1753, 1759, 1777, 1783, 1787, 1789, 1801, 1811,
|
|
||||||
1823, 1831, 1847, 1861, 1867, 1871, 1873, 1877,
|
|
||||||
1879, 1889, 1901, 1907, 1913, 1931, 1933, 1949,
|
|
||||||
1951, 1973, 1979, 1987, 1993, 1997, 1999, 2003,
|
|
||||||
2011, 2017, 2027, 2029, 2039, 2053, 2063, 2069,
|
|
||||||
2081, 2083, 2087, 2089, 2099, 2111, 2113, 2129,
|
|
||||||
2131, 2137, 2141, 2143, 2153, 2161, 2179, 2203,
|
|
||||||
2207, 2213, 2221, 2237, 2239, 2243, 2251, 2267,
|
|
||||||
2269, 2273, 2281, 2287, 2293, 2297, 2309, 2311,
|
|
||||||
2333, 2339, 2341, 2347, 2351, 2357, 2371, 2377,
|
|
||||||
2381, 2383, 2389, 2393, 2399, 2411, 2417, 2423,
|
|
||||||
2437, 2441, 2447, 2459, 2467, 2473, 2477, 2503,
|
|
||||||
2521, 2531, 2539, 2543, 2549, 2551, 2557, 2579,
|
|
||||||
2591, 2593, 2609, 2617, 2621, 2633, 2647, 2657,
|
|
||||||
2659, 2663, 2671, 2677, 2683, 2687, 2689, 2693,
|
|
||||||
2699, 2707, 2711, 2713, 2719, 2729, 2731, 2741,
|
|
||||||
2749, 2753, 2767, 2777, 2789, 2791, 2797, 2801,
|
|
||||||
2803, 2819, 2833, 2837, 2843, 2851, 2857, 2861,
|
|
||||||
2879, 2887, 2897, 2903, 2909, 2917, 2927, 2939,
|
|
||||||
2953, 2957, 2963, 2969, 2971, 2999, 3001, 3011,
|
|
||||||
3019, 3023, 3037, 3041, 3049, 3061, 3067, 3079,
|
|
||||||
3083, 3089, 3109, 3119, 3121, 3137, 3163, 3167,
|
|
||||||
3169, 3181, 3187, 3191, 3203, 3209, 3217, 3221,
|
|
||||||
3229, 3251, 3253, 3257, 3259, 3271, 3299, 3301,
|
|
||||||
3307, 3313, 3319, 3323, 3329, 3331, 3343, 3347,
|
|
||||||
3359, 3361, 3371, 3373, 3389, 3391, 3407, 3413,
|
|
||||||
3433, 3449, 3457, 3461, 3463, 3467, 3469, 3491,
|
|
||||||
3499, 3511, 3517, 3527, 3529, 3533, 3539, 3541,
|
|
||||||
3547, 3557, 3559, 3571, 3581, 3583, 3593, 3607,
|
|
||||||
3613, 3617, 3623, 3631, 3637, 3643, 3659, 3671,
|
|
||||||
3673, 3677, 3691, 3697, 3701, 3709, 3719, 3727,
|
|
||||||
3733, 3739, 3761, 3767, 3769, 3779, 3793, 3797,
|
|
||||||
3803, 3821, 3823, 3833, 3847, 3851, 3853, 3863,
|
|
||||||
3877, 3881, 3889, 3907, 3911, 3917, 3919, 3923,
|
|
||||||
3929, 3931, 3943, 3947, 3967, 3989, 4001, 4003,
|
|
||||||
4007, 4013, 4019, 4021, 4027, 4049, 4051, 4057,
|
|
||||||
4073, 4079, 4091, 4093, 4099, 4111, 4127, 4129,
|
|
||||||
4133, 4139, 4153, 4157, 4159, 4177, 4201, 4211,
|
|
||||||
4217, 4219, 4229, 4231, 4241, 4243, 4253, 4259,
|
|
||||||
4261, 4271, 4273, 4283, 4289, 4297, 4327, 4337,
|
|
||||||
4339, 4349, 4357, 4363, 4373, 4391, 4397, 4409,
|
|
||||||
4421, 4423, 4441, 4447, 4451, 4457, 4463, 4481,
|
|
||||||
4483, 4493, 4507, 4513, 4517, 4519, 4523, 4547,
|
|
||||||
4549, 4561, 4567, 4583, 4591, 4597, 4603, 4621,
|
|
||||||
4637, 4639, 4643, 4649, 4651, 4657, 4663, 4673,
|
|
||||||
4679, 4691, 4703, 4721, 4723, 4729, 4733, 4751,
|
|
||||||
4759, 4783, 4787, 4789, 4793, 4799, 4801, 4813,
|
|
||||||
4817, 4831, 4861, 4871, 4877, 4889, 4903, 4909,
|
|
||||||
4919, 4931, 4933, 4937, 4943, 4951, 4957, 4967,
|
|
||||||
4969, 4973, 4987, 4993, 4999, 5003, 5009, 5011,
|
|
||||||
5021, 5023, 5039, 5051, 5059, 5077, 5081, 5087,
|
|
||||||
5099, 5101, 5107, 5113, 5119, 5147, 5153, 5167,
|
|
||||||
5171, 5179, 5189, 5197, 5209, 5227, 5231, 5233,
|
|
||||||
5237, 5261, 5273, 5279, 5281, 5297, 5303, 5309,
|
|
||||||
5323, 5333, 5347, 5351, 5381, 5387, 5393, 5399,
|
|
||||||
5407, 5413, 5417, 5419, 5431, 5437, 5441, 5443,
|
|
||||||
5449, 5471, 5477, 5479, 5483, 5501, 5503, 5507,
|
|
||||||
5519, 5521, 5527, 5531, 5557, 5563, 5569, 5573,
|
|
||||||
5581, 5591, 5623, 5639, 5641, 5647, 5651, 5653,
|
|
||||||
5657, 5659, 5669, 5683, 5689, 5693, 5701, 5711,
|
|
||||||
5717, 5737, 5741, 5743, 5749, 5779, 5783, 5791,
|
|
||||||
5801, 5807, 5813, 5821, 5827, 5839, 5843, 5849,
|
|
||||||
5851, 5857, 5861, 5867, 5869, 5879, 5881, 5897,
|
|
||||||
5903, 5923, 5927, 5939, 5953, 5981, 5987, 6007,
|
|
||||||
6011, 6029, 6037, 6043, 6047, 6053, 6067, 6073,
|
|
||||||
6079, 6089, 6091, 6101, 6113, 6121, 6131, 6133,
|
|
||||||
6143, 6151, 6163, 6173, 6197, 6199, 6203, 6211,
|
|
||||||
6217, 6221, 6229, 6247, 6257, 6263, 6269, 6271,
|
|
||||||
6277, 6287, 6299, 6301, 6311, 6317, 6323, 6329,
|
|
||||||
6337, 6343, 6353, 6359, 6361, 6367, 6373, 6379,
|
|
||||||
6389, 6397, 6421, 6427, 6449, 6451, 6469, 6473,
|
|
||||||
6481, 6491, 6521, 6529, 6547, 6551, 6553, 6563,
|
|
||||||
6569, 6571, 6577, 6581, 6599, 6607, 6619, 6637,
|
|
||||||
6653, 6659, 6661, 6673, 6679, 6689, 6691, 6701,
|
|
||||||
6703, 6709, 6719, 6733, 6737, 6761, 6763, 6779,
|
|
||||||
6781, 6791, 6793, 6803, 6823, 6827, 6829, 6833,
|
|
||||||
6841, 6857, 6863, 6869, 6871, 6883, 6899, 6907,
|
|
||||||
6911, 6917, 6947, 6949, 6959, 6961, 6967, 6971,
|
|
||||||
6977, 6983, 6991, 6997, 7001, 7013, 7019, 7027,
|
|
||||||
7039, 7043, 7057, 7069, 7079, 7103, 7109, 7121,
|
|
||||||
7127, 7129, 7151, 7159, 7177, 7187, 7193, 7207,
|
|
||||||
7211, 7213, 7219, 7229, 7237, 7243, 7247, 7253,
|
|
||||||
7283, 7297, 7307, 7309, 7321, 7331, 7333, 7349,
|
|
||||||
7351, 7369, 7393, 7411, 7417, 7433, 7451, 7457,
|
|
||||||
7459, 7477, 7481, 7487, 7489, 7499, 7507, 7517,
|
|
||||||
7523, 7529, 7537, 7541, 7547, 7549, 7559, 7561,
|
|
||||||
7573, 7577, 7583, 7589, 7591, 7603, 7607, 7621,
|
|
||||||
7639, 7643, 7649, 7669, 7673, 7681, 7687, 7691,
|
|
||||||
7699, 7703, 7717, 7723, 7727, 7741, 7753, 7757,
|
|
||||||
7759, 7789, 7793, 7817, 7823, 7829, 7841, 7853,
|
|
||||||
7867, 7873, 7877, 7879, 7883, 7901, 7907, 7919,
|
|
||||||
7927, 7933, 7937, 7949, 7951, 7963, 7993, 8009,
|
|
||||||
8011, 8017, 8039, 8053, 8059, 8069, 8081, 8087,
|
|
||||||
8089, 8093, 8101, 8111, 8117, 8123, 8147, 8161,
|
|
||||||
8167, 8171, 8179, 8191, 8209, 8219, 8221, 8231,
|
|
||||||
8233, 8237, 8243, 8263, 8269, 8273, 8287, 8291,
|
|
||||||
8293, 8297, 8311, 8317, 8329, 8353, 8363, 8369,
|
|
||||||
8377, 8387, 8389, 8419, 8423, 8429, 8431, 8443,
|
|
||||||
8447, 8461, 8467, 8501, 8513, 8521, 8527, 8537,
|
|
||||||
8539, 8543, 8563, 8573, 8581, 8597, 8599, 8609,
|
|
||||||
8623, 8627, 8629, 8641, 8647, 8663, 8669, 8677,
|
|
||||||
8681, 8689, 8693, 8699, 8707, 8713, 8719, 8731,
|
|
||||||
8737, 8741, 8747, 8753, 8761, 8779, 8783, 8803,
|
|
||||||
8807, 8819, 8821, 8831, 8837, 8839, 8849, 8861,
|
|
||||||
8863, 8867, 8887, 8893, 8923, 8929, 8933, 8941,
|
|
||||||
8951, 8963, 8969, 8971, 8999, 9001, 9007, 9011,
|
|
||||||
9013, 9029, 9041, 9043, 9049, 9059, 9067, 9091,
|
|
||||||
9103, 9109, 9127, 9133, 9137, 9151, 9157, 9161,
|
|
||||||
9173, 9181, 9187, 9199, 9203, 9209, 9221, 9227,
|
|
||||||
9239, 9241, 9257, 9277, 9281, 9283, 9293, 9311,
|
|
||||||
9319, 9323, 9337, 9341, 9343, 9349, 9371, 9377,
|
|
||||||
9391, 9397, 9403, 9413, 9419, 9421, 9431, 9433,
|
|
||||||
9437, 9439, 9461, 9463, 9467, 9473, 9479, 9491,
|
|
||||||
9497, 9511, 9521, 9533, 9539, 9547, 9551, 9587,
|
|
||||||
9601, 9613, 9619, 9623, 9629, 9631, 9643, 9649,
|
|
||||||
9661, 9677, 9679, 9689, 9697, 9719, 9721, 9733,
|
|
||||||
9739, 9743, 9749, 9767, 9769, 9781, 9787, 9791,
|
|
||||||
9803, 9811, 9817, 9829, 9833, 9839, 9851, 9857,
|
|
||||||
9859, 9871, 9883, 9887, 9901, 9907, 9923, 9929,
|
|
||||||
9931, 9941, 9949, 9967, 9973, 10007, 10009, 10037,
|
|
||||||
10039, 10061, 10067, 10069, 10079, 10091, 10093, 10099,
|
|
||||||
10103, 10111, 10133, 10139, 10141, 10151, 10159, 10163,
|
|
||||||
10169, 10177, 10181, 10193, 10211, 10223, 10243, 10247,
|
|
||||||
10253, 10259, 10267, 10271, 10273, 10289, 10301, 10303,
|
|
||||||
10313, 10321, 10331, 10333, 10337, 10343, 10357, 10369,
|
|
||||||
10391, 10399, 10427, 10429, 10433, 10453, 10457, 10459,
|
|
||||||
10463, 10477, 10487, 10499, 10501, 10513, 10529, 10531,
|
|
||||||
10559, 10567, 10589, 10597, 10601, 10607, 10613, 10627,
|
|
||||||
10631, 10639, 10651, 10657, 10663, 10667, 10687, 10691,
|
|
||||||
10709, 10711, 10723, 10729, 10733, 10739, 10753, 10771,
|
|
||||||
10781, 10789, 10799, 10831, 10837, 10847, 10853, 10859,
|
|
||||||
10861, 10867, 10883, 10889, 10891, 10903, 10909, 10937,
|
|
||||||
10939, 10949, 10957, 10973, 10979, 10987, 10993, 11003,
|
|
||||||
11027, 11047, 11057, 11059, 11069, 11071, 11083, 11087,
|
|
||||||
11093, 11113, 11117, 11119, 11131, 11149, 11159, 11161,
|
|
||||||
11171, 11173, 11177, 11197, 11213, 11239, 11243, 11251,
|
|
||||||
11257, 11261, 11273, 11279, 11287, 11299, 11311, 11317,
|
|
||||||
11321, 11329, 11351, 11353, 11369, 11383, 11393, 11399,
|
|
||||||
11411, 11423, 11437, 11443, 11447, 11467, 11471, 11483,
|
|
||||||
11489, 11491, 11497, 11503, 11519, 11527, 11549, 11551,
|
|
||||||
11579, 11587, 11593, 11597, 11617, 11621, 11633, 11657,
|
|
||||||
11677, 11681, 11689, 11699, 11701, 11717, 11719, 11731,
|
|
||||||
11743, 11777, 11779, 11783, 11789, 11801, 11807, 11813,
|
|
||||||
11821, 11827, 11831, 11833, 11839, 11863, 11867, 11887,
|
|
||||||
11897, 11903, 11909, 11923, 11927, 11933, 11939, 11941,
|
|
||||||
11953, 11959, 11969, 11971, 11981, 11987, 12007, 12011,
|
|
||||||
12037, 12041, 12043, 12049, 12071, 12073, 12097, 12101,
|
|
||||||
12107, 12109, 12113, 12119, 12143, 12149, 12157, 12161,
|
|
||||||
12163, 12197, 12203, 12211, 12227, 12239, 12241, 12251,
|
|
||||||
12253, 12263, 12269, 12277, 12281, 12289, 12301, 12323,
|
|
||||||
12329, 12343, 12347, 12373, 12377, 12379, 12391, 12401,
|
|
||||||
12409, 12413, 12421, 12433, 12437, 12451, 12457, 12473,
|
|
||||||
12479, 12487, 12491, 12497, 12503, 12511, 12517, 12527,
|
|
||||||
12539, 12541, 12547, 12553, 12569, 12577, 12583, 12589,
|
|
||||||
12601, 12611, 12613, 12619, 12637, 12641, 12647, 12653,
|
|
||||||
12659, 12671, 12689, 12697, 12703, 12713, 12721, 12739,
|
|
||||||
12743, 12757, 12763, 12781, 12791, 12799, 12809, 12821,
|
|
||||||
12823, 12829, 12841, 12853, 12889, 12893, 12899, 12907,
|
|
||||||
12911, 12917, 12919, 12923, 12941, 12953, 12959, 12967,
|
|
||||||
12973, 12979, 12983, 13001, 13003, 13007, 13009, 13033,
|
|
||||||
13037, 13043, 13049, 13063, 13093, 13099, 13103, 13109,
|
|
||||||
13121, 13127, 13147, 13151, 13159, 13163, 13171, 13177,
|
|
||||||
13183, 13187, 13217, 13219, 13229, 13241, 13249, 13259,
|
|
||||||
13267, 13291, 13297, 13309, 13313, 13327, 13331, 13337,
|
|
||||||
13339, 13367, 13381, 13397, 13399, 13411, 13417, 13421,
|
|
||||||
13441, 13451, 13457, 13463, 13469, 13477, 13487, 13499,
|
|
||||||
13513, 13523, 13537, 13553, 13567, 13577, 13591, 13597,
|
|
||||||
13613, 13619, 13627, 13633, 13649, 13669, 13679, 13681,
|
|
||||||
13687, 13691, 13693, 13697, 13709, 13711, 13721, 13723,
|
|
||||||
13729, 13751, 13757, 13759, 13763, 13781, 13789, 13799,
|
|
||||||
13807, 13829, 13831, 13841, 13859, 13873, 13877, 13879,
|
|
||||||
13883, 13901, 13903, 13907, 13913, 13921, 13931, 13933,
|
|
||||||
13963, 13967, 13997, 13999, 14009, 14011, 14029, 14033,
|
|
||||||
14051, 14057, 14071, 14081, 14083, 14087, 14107, 14143,
|
|
||||||
14149, 14153, 14159, 14173, 14177, 14197, 14207, 14221,
|
|
||||||
14243, 14249, 14251, 14281, 14293, 14303, 14321, 14323,
|
|
||||||
14327, 14341, 14347, 14369, 14387, 14389, 14401, 14407,
|
|
||||||
14411, 14419, 14423, 14431, 14437, 14447, 14449, 14461,
|
|
||||||
14479, 14489, 14503, 14519, 14533, 14537, 14543, 14549,
|
|
||||||
14551, 14557, 14561, 14563, 14591, 14593, 14621, 14627,
|
|
||||||
14629, 14633, 14639, 14653, 14657, 14669, 14683, 14699,
|
|
||||||
14713, 14717, 14723, 14731, 14737, 14741, 14747, 14753,
|
|
||||||
14759, 14767, 14771, 14779, 14783, 14797, 14813, 14821,
|
|
||||||
14827, 14831, 14843, 14851, 14867, 14869, 14879, 14887,
|
|
||||||
14891, 14897, 14923, 14929, 14939, 14947, 14951, 14957,
|
|
||||||
14969, 14983, 15013, 15017, 15031, 15053, 15061, 15073,
|
|
||||||
15077, 15083, 15091, 15101, 15107, 15121, 15131, 15137,
|
|
||||||
15139, 15149, 15161, 15173, 15187, 15193, 15199, 15217,
|
|
||||||
15227, 15233, 15241, 15259, 15263, 15269, 15271, 15277,
|
|
||||||
15287, 15289, 15299, 15307, 15313, 15319, 15329, 15331,
|
|
||||||
15349, 15359, 15361, 15373, 15377, 15383, 15391, 15401,
|
|
||||||
15413, 15427, 15439, 15443, 15451, 15461, 15467, 15473,
|
|
||||||
15493, 15497, 15511, 15527, 15541, 15551, 15559, 15569,
|
|
||||||
15581, 15583, 15601, 15607, 15619, 15629, 15641, 15643,
|
|
||||||
15647, 15649, 15661, 15667, 15671, 15679, 15683, 15727,
|
|
||||||
15731, 15733, 15737, 15739, 15749, 15761, 15767, 15773,
|
|
||||||
15787, 15791, 15797, 15803, 15809, 15817, 15823, 15859,
|
|
||||||
15877, 15881, 15887, 15889, 15901, 15907, 15913, 15919,
|
|
||||||
15923, 15937, 15959, 15971, 15973, 15991, 16001, 16007,
|
|
||||||
16033, 16057, 16061, 16063, 16067, 16069, 16073, 16087,
|
|
||||||
16091, 16097, 16103, 16111, 16127, 16139, 16141, 16183,
|
|
||||||
16187, 16189, 16193, 16217, 16223, 16229, 16231, 16249,
|
|
||||||
16253, 16267, 16273, 16301, 16319, 16333, 16339, 16349,
|
|
||||||
16361, 16363, 16369, 16381, 16411, 16417, 16421, 16427,
|
|
||||||
16433, 16447, 16451, 16453, 16477, 16481, 16487, 16493,
|
|
||||||
16519, 16529, 16547, 16553, 16561, 16567, 16573, 16603,
|
|
||||||
16607, 16619, 16631, 16633, 16649, 16651, 16657, 16661,
|
|
||||||
16673, 16691, 16693, 16699, 16703, 16729, 16741, 16747,
|
|
||||||
16759, 16763, 16787, 16811, 16823, 16829, 16831, 16843,
|
|
||||||
16871, 16879, 16883, 16889, 16901, 16903, 16921, 16927,
|
|
||||||
16931, 16937, 16943, 16963, 16979, 16981, 16987, 16993,
|
|
||||||
17011, 17021, 17027, 17029, 17033, 17041, 17047, 17053,
|
|
||||||
17077, 17093, 17099, 17107, 17117, 17123, 17137, 17159,
|
|
||||||
17167, 17183, 17189, 17191, 17203, 17207, 17209, 17231,
|
|
||||||
17239, 17257, 17291, 17293, 17299, 17317, 17321, 17327,
|
|
||||||
17333, 17341, 17351, 17359, 17377, 17383, 17387, 17389,
|
|
||||||
17393, 17401, 17417, 17419, 17431, 17443, 17449, 17467,
|
|
||||||
17471, 17477, 17483, 17489, 17491, 17497, 17509, 17519,
|
|
||||||
17539, 17551, 17569, 17573, 17579, 17581, 17597, 17599,
|
|
||||||
17609, 17623, 17627, 17657, 17659, 17669, 17681, 17683,
|
|
||||||
17707, 17713, 17729, 17737, 17747, 17749, 17761, 17783,
|
|
||||||
17789, 17791, 17807, 17827, 17837, 17839, 17851, 17863,
|
|
||||||
}
|
|
104
vendor/github.com/Luzifer/go-dhparam/validate.go
generated
vendored
104
vendor/github.com/Luzifer/go-dhparam/validate.go
generated
vendored
|
@ -1,104 +0,0 @@
|
||||||
package dhparam
|
|
||||||
|
|
||||||
import (
|
|
||||||
"math/big"
|
|
||||||
|
|
||||||
"github.com/pkg/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
const dhCheckPNotPrime = 0x01
|
|
||||||
const dhCheckPNotSafePrime = 0x02
|
|
||||||
const dhUnableToCheckGenerator = 0x04
|
|
||||||
const dhNotSuitableGenerator = 0x08
|
|
||||||
const dhCheckQNotPrime = 0x10
|
|
||||||
const dhCheckInvalidQValue = 0x20
|
|
||||||
const dhCheckInvalidJValue = 0x40
|
|
||||||
|
|
||||||
// ErrAllParametersOK is defined to check whether the returned error from Check is indeed no error
|
|
||||||
// For simplicity reasons it is defined as an error instead of an additional result parameter
|
|
||||||
var ErrAllParametersOK = errors.New("DH parameters appear to be ok")
|
|
||||||
|
|
||||||
// Check returns a number of errors and an "ok" bool. If the "ok" bool is set to true, still one
|
|
||||||
// error is returned: ErrAllParametersOK. If "ok" is false, the error list will contain at least
|
|
||||||
// one error not being equal to ErrAllParametersOK.
|
|
||||||
func (d DH) Check() ([]error, bool) {
|
|
||||||
var (
|
|
||||||
result = []error{}
|
|
||||||
ok = true
|
|
||||||
)
|
|
||||||
|
|
||||||
i := d.check()
|
|
||||||
|
|
||||||
if i&dhCheckPNotPrime > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: p value is not prime"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhCheckPNotSafePrime > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: p value is not a safe prime"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhCheckQNotPrime > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: q value is not a prime"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhCheckInvalidQValue > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: q value is invalid"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhCheckInvalidJValue > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: j value is invalid"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhUnableToCheckGenerator > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: unable to check the generator value"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i&dhNotSuitableGenerator > 0 {
|
|
||||||
result = append(result, errors.New("WARNING: the g value is not a generator"))
|
|
||||||
ok = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if i == 0 {
|
|
||||||
result = append(result, ErrAllParametersOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
return result, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d DH) check() int {
|
|
||||||
var ret int
|
|
||||||
|
|
||||||
// Check generator
|
|
||||||
switch d.G {
|
|
||||||
case 2:
|
|
||||||
l := new(big.Int)
|
|
||||||
if l.Mod(d.P, big.NewInt(24)); l.Int64() != 11 {
|
|
||||||
ret |= dhNotSuitableGenerator
|
|
||||||
}
|
|
||||||
case 5:
|
|
||||||
l := new(big.Int)
|
|
||||||
if l.Mod(d.P, big.NewInt(10)); l.Int64() != 3 && l.Int64() != 7 {
|
|
||||||
ret |= dhNotSuitableGenerator
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
ret |= dhUnableToCheckGenerator
|
|
||||||
}
|
|
||||||
|
|
||||||
if !d.P.ProbablyPrime(1) {
|
|
||||||
ret |= dhCheckPNotPrime
|
|
||||||
} else {
|
|
||||||
t1 := new(big.Int)
|
|
||||||
t1.Rsh(d.P, 1)
|
|
||||||
if !t1.ProbablyPrime(1) {
|
|
||||||
ret |= dhCheckPNotSafePrime
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return ret
|
|
||||||
}
|
|
5
vendor/github.com/fsnotify/fsnotify/.editorconfig
generated
vendored
5
vendor/github.com/fsnotify/fsnotify/.editorconfig
generated
vendored
|
@ -1,5 +0,0 @@
|
||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
indent_style = tab
|
|
||||||
indent_size = 4
|
|
6
vendor/github.com/fsnotify/fsnotify/.gitignore
generated
vendored
6
vendor/github.com/fsnotify/fsnotify/.gitignore
generated
vendored
|
@ -1,6 +0,0 @@
|
||||||
# Setup a Global .gitignore for OS and editor generated files:
|
|
||||||
# https://help.github.com/articles/ignoring-files
|
|
||||||
# git config --global core.excludesfile ~/.gitignore_global
|
|
||||||
|
|
||||||
.vagrant
|
|
||||||
*.sublime-project
|
|
30
vendor/github.com/fsnotify/fsnotify/.travis.yml
generated
vendored
30
vendor/github.com/fsnotify/fsnotify/.travis.yml
generated
vendored
|
@ -1,30 +0,0 @@
|
||||||
sudo: false
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8.x
|
|
||||||
- 1.9.x
|
|
||||||
- tip
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
allow_failures:
|
|
||||||
- go: tip
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
before_script:
|
|
||||||
- go get -u github.com/golang/lint/golint
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go test -v --race ./...
|
|
||||||
|
|
||||||
after_script:
|
|
||||||
- test -z "$(gofmt -s -l -w . | tee /dev/stderr)"
|
|
||||||
- test -z "$(golint ./... | tee /dev/stderr)"
|
|
||||||
- go vet ./...
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
email: false
|
|
52
vendor/github.com/fsnotify/fsnotify/AUTHORS
generated
vendored
52
vendor/github.com/fsnotify/fsnotify/AUTHORS
generated
vendored
|
@ -1,52 +0,0 @@
|
||||||
# Names should be added to this file as
|
|
||||||
# Name or Organization <email address>
|
|
||||||
# The email address is not required for organizations.
|
|
||||||
|
|
||||||
# You can update this list using the following command:
|
|
||||||
#
|
|
||||||
# $ git shortlog -se | awk '{print $2 " " $3 " " $4}'
|
|
||||||
|
|
||||||
# Please keep the list sorted.
|
|
||||||
|
|
||||||
Aaron L <aaron@bettercoder.net>
|
|
||||||
Adrien Bustany <adrien@bustany.org>
|
|
||||||
Amit Krishnan <amit.krishnan@oracle.com>
|
|
||||||
Anmol Sethi <me@anmol.io>
|
|
||||||
Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
|
|
||||||
Bruno Bigras <bigras.bruno@gmail.com>
|
|
||||||
Caleb Spare <cespare@gmail.com>
|
|
||||||
Case Nelson <case@teammating.com>
|
|
||||||
Chris Howey <chris@howey.me> <howeyc@gmail.com>
|
|
||||||
Christoffer Buchholz <christoffer.buchholz@gmail.com>
|
|
||||||
Daniel Wagner-Hall <dawagner@gmail.com>
|
|
||||||
Dave Cheney <dave@cheney.net>
|
|
||||||
Evan Phoenix <evan@fallingsnow.net>
|
|
||||||
Francisco Souza <f@souza.cc>
|
|
||||||
Hari haran <hariharan.uno@gmail.com>
|
|
||||||
John C Barstow
|
|
||||||
Kelvin Fo <vmirage@gmail.com>
|
|
||||||
Ken-ichirou MATSUZAWA <chamas@h4.dion.ne.jp>
|
|
||||||
Matt Layher <mdlayher@gmail.com>
|
|
||||||
Nathan Youngman <git@nathany.com>
|
|
||||||
Nickolai Zeldovich <nickolai@csail.mit.edu>
|
|
||||||
Patrick <patrick@dropbox.com>
|
|
||||||
Paul Hammond <paul@paulhammond.org>
|
|
||||||
Pawel Knap <pawelknap88@gmail.com>
|
|
||||||
Pieter Droogendijk <pieter@binky.org.uk>
|
|
||||||
Pursuit92 <JoshChase@techpursuit.net>
|
|
||||||
Riku Voipio <riku.voipio@linaro.org>
|
|
||||||
Rob Figueiredo <robfig@gmail.com>
|
|
||||||
Rodrigo Chiossi <rodrigochiossi@gmail.com>
|
|
||||||
Slawek Ligus <root@ooz.ie>
|
|
||||||
Soge Zhang <zhssoge@gmail.com>
|
|
||||||
Tiffany Jernigan <tiffany.jernigan@intel.com>
|
|
||||||
Tilak Sharma <tilaks@google.com>
|
|
||||||
Tom Payne <twpayne@gmail.com>
|
|
||||||
Travis Cline <travis.cline@gmail.com>
|
|
||||||
Tudor Golubenco <tudor.g@gmail.com>
|
|
||||||
Vahe Khachikyan <vahe@live.ca>
|
|
||||||
Yukang <moorekang@gmail.com>
|
|
||||||
bronze1man <bronze1man@gmail.com>
|
|
||||||
debrando <denis.brandolini@gmail.com>
|
|
||||||
henrikedwards <henrik.edwards@gmail.com>
|
|
||||||
铁哥 <guotie.9@gmail.com>
|
|
317
vendor/github.com/fsnotify/fsnotify/CHANGELOG.md
generated
vendored
317
vendor/github.com/fsnotify/fsnotify/CHANGELOG.md
generated
vendored
|
@ -1,317 +0,0 @@
|
||||||
# Changelog
|
|
||||||
|
|
||||||
## v1.4.7 / 2018-01-09
|
|
||||||
|
|
||||||
* BSD/macOS: Fix possible deadlock on closing the watcher on kqueue (thanks @nhooyr and @glycerine)
|
|
||||||
* Tests: Fix missing verb on format string (thanks @rchiossi)
|
|
||||||
* Linux: Fix deadlock in Remove (thanks @aarondl)
|
|
||||||
* Linux: Watch.Add improvements (avoid race, fix consistency, reduce garbage) (thanks @twpayne)
|
|
||||||
* Docs: Moved FAQ into the README (thanks @vahe)
|
|
||||||
* Linux: Properly handle inotify's IN_Q_OVERFLOW event (thanks @zeldovich)
|
|
||||||
* Docs: replace references to OS X with macOS
|
|
||||||
|
|
||||||
## v1.4.2 / 2016-10-10
|
|
||||||
|
|
||||||
* Linux: use InotifyInit1 with IN_CLOEXEC to stop leaking a file descriptor to a child process when using fork/exec [#178](https://github.com/fsnotify/fsnotify/pull/178) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## v1.4.1 / 2016-10-04
|
|
||||||
|
|
||||||
* Fix flaky inotify stress test on Linux [#177](https://github.com/fsnotify/fsnotify/pull/177) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## v1.4.0 / 2016-10-01
|
|
||||||
|
|
||||||
* add a String() method to Event.Op [#165](https://github.com/fsnotify/fsnotify/pull/165) (thanks @oozie)
|
|
||||||
|
|
||||||
## v1.3.1 / 2016-06-28
|
|
||||||
|
|
||||||
* Windows: fix for double backslash when watching the root of a drive [#151](https://github.com/fsnotify/fsnotify/issues/151) (thanks @brunoqc)
|
|
||||||
|
|
||||||
## v1.3.0 / 2016-04-19
|
|
||||||
|
|
||||||
* Support linux/arm64 by [patching](https://go-review.googlesource.com/#/c/21971/) x/sys/unix and switching to to it from syscall (thanks @suihkulokki) [#135](https://github.com/fsnotify/fsnotify/pull/135)
|
|
||||||
|
|
||||||
## v1.2.10 / 2016-03-02
|
|
||||||
|
|
||||||
* Fix golint errors in windows.go [#121](https://github.com/fsnotify/fsnotify/pull/121) (thanks @tiffanyfj)
|
|
||||||
|
|
||||||
## v1.2.9 / 2016-01-13
|
|
||||||
|
|
||||||
kqueue: Fix logic for CREATE after REMOVE [#111](https://github.com/fsnotify/fsnotify/pull/111) (thanks @bep)
|
|
||||||
|
|
||||||
## v1.2.8 / 2015-12-17
|
|
||||||
|
|
||||||
* kqueue: fix race condition in Close [#105](https://github.com/fsnotify/fsnotify/pull/105) (thanks @djui for reporting the issue and @ppknap for writing a failing test)
|
|
||||||
* inotify: fix race in test
|
|
||||||
* enable race detection for continuous integration (Linux, Mac, Windows)
|
|
||||||
|
|
||||||
## v1.2.5 / 2015-10-17
|
|
||||||
|
|
||||||
* inotify: use epoll_create1 for arm64 support (requires Linux 2.6.27 or later) [#100](https://github.com/fsnotify/fsnotify/pull/100) (thanks @suihkulokki)
|
|
||||||
* inotify: fix path leaks [#73](https://github.com/fsnotify/fsnotify/pull/73) (thanks @chamaken)
|
|
||||||
* kqueue: watch for rename events on subdirectories [#83](https://github.com/fsnotify/fsnotify/pull/83) (thanks @guotie)
|
|
||||||
* kqueue: avoid infinite loops from symlinks cycles [#101](https://github.com/fsnotify/fsnotify/pull/101) (thanks @illicitonion)
|
|
||||||
|
|
||||||
## v1.2.1 / 2015-10-14
|
|
||||||
|
|
||||||
* kqueue: don't watch named pipes [#98](https://github.com/fsnotify/fsnotify/pull/98) (thanks @evanphx)
|
|
||||||
|
|
||||||
## v1.2.0 / 2015-02-08
|
|
||||||
|
|
||||||
* inotify: use epoll to wake up readEvents [#66](https://github.com/fsnotify/fsnotify/pull/66) (thanks @PieterD)
|
|
||||||
* inotify: closing watcher should now always shut down goroutine [#63](https://github.com/fsnotify/fsnotify/pull/63) (thanks @PieterD)
|
|
||||||
* kqueue: close kqueue after removing watches, fixes [#59](https://github.com/fsnotify/fsnotify/issues/59)
|
|
||||||
|
|
||||||
## v1.1.1 / 2015-02-05
|
|
||||||
|
|
||||||
* inotify: Retry read on EINTR [#61](https://github.com/fsnotify/fsnotify/issues/61) (thanks @PieterD)
|
|
||||||
|
|
||||||
## v1.1.0 / 2014-12-12
|
|
||||||
|
|
||||||
* kqueue: rework internals [#43](https://github.com/fsnotify/fsnotify/pull/43)
|
|
||||||
* add low-level functions
|
|
||||||
* only need to store flags on directories
|
|
||||||
* less mutexes [#13](https://github.com/fsnotify/fsnotify/issues/13)
|
|
||||||
* done can be an unbuffered channel
|
|
||||||
* remove calls to os.NewSyscallError
|
|
||||||
* More efficient string concatenation for Event.String() [#52](https://github.com/fsnotify/fsnotify/pull/52) (thanks @mdlayher)
|
|
||||||
* kqueue: fix regression in rework causing subdirectories to be watched [#48](https://github.com/fsnotify/fsnotify/issues/48)
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## v1.0.4 / 2014-09-07
|
|
||||||
|
|
||||||
* kqueue: add dragonfly to the build tags.
|
|
||||||
* Rename source code files, rearrange code so exported APIs are at the top.
|
|
||||||
* Add done channel to example code. [#37](https://github.com/fsnotify/fsnotify/pull/37) (thanks @chenyukang)
|
|
||||||
|
|
||||||
## v1.0.3 / 2014-08-19
|
|
||||||
|
|
||||||
* [Fix] Windows MOVED_TO now translates to Create like on BSD and Linux. [#36](https://github.com/fsnotify/fsnotify/issues/36)
|
|
||||||
|
|
||||||
## v1.0.2 / 2014-08-17
|
|
||||||
|
|
||||||
* [Fix] Missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
* [Fix] Make ./path and path equivalent. (thanks @zhsso)
|
|
||||||
|
|
||||||
## v1.0.0 / 2014-08-15
|
|
||||||
|
|
||||||
* [API] Remove AddWatch on Windows, use Add.
|
|
||||||
* Improve documentation for exported identifiers. [#30](https://github.com/fsnotify/fsnotify/issues/30)
|
|
||||||
* Minor updates based on feedback from golint.
|
|
||||||
|
|
||||||
## dev / 2014-07-09
|
|
||||||
|
|
||||||
* Moved to [github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify).
|
|
||||||
* Use os.NewSyscallError instead of returning errno (thanks @hariharan-uno)
|
|
||||||
|
|
||||||
## dev / 2014-07-04
|
|
||||||
|
|
||||||
* kqueue: fix incorrect mutex used in Close()
|
|
||||||
* Update example to demonstrate usage of Op.
|
|
||||||
|
|
||||||
## dev / 2014-06-28
|
|
||||||
|
|
||||||
* [API] Don't set the Write Op for attribute notifications [#4](https://github.com/fsnotify/fsnotify/issues/4)
|
|
||||||
* Fix for String() method on Event (thanks Alex Brainman)
|
|
||||||
* Don't build on Plan 9 or Solaris (thanks @4ad)
|
|
||||||
|
|
||||||
## dev / 2014-06-21
|
|
||||||
|
|
||||||
* Events channel of type Event rather than *Event.
|
|
||||||
* [internal] use syscall constants directly for inotify and kqueue.
|
|
||||||
* [internal] kqueue: rename events to kevents and fileEvent to event.
|
|
||||||
|
|
||||||
## dev / 2014-06-19
|
|
||||||
|
|
||||||
* Go 1.3+ required on Windows (uses syscall.ERROR_MORE_DATA internally).
|
|
||||||
* [internal] remove cookie from Event struct (unused).
|
|
||||||
* [internal] Event struct has the same definition across every OS.
|
|
||||||
* [internal] remove internal watch and removeWatch methods.
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* [API] Renamed Watch() to Add() and RemoveWatch() to Remove().
|
|
||||||
* [API] Pluralized channel names: Events and Errors.
|
|
||||||
* [API] Renamed FileEvent struct to Event.
|
|
||||||
* [API] Op constants replace methods like IsCreate().
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## dev / 2014-05-23
|
|
||||||
|
|
||||||
* [API] Remove current implementation of WatchFlags.
|
|
||||||
* current implementation doesn't take advantage of OS for efficiency
|
|
||||||
* provides little benefit over filtering events as they are received, but has extra bookkeeping and mutexes
|
|
||||||
* no tests for the current implementation
|
|
||||||
* not fully implemented on Windows [#93](https://github.com/howeyc/fsnotify/issues/93#issuecomment-39285195)
|
|
||||||
|
|
||||||
## v0.9.3 / 2014-12-31
|
|
||||||
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## v0.9.2 / 2014-08-17
|
|
||||||
|
|
||||||
* [Backport] Fix missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
|
|
||||||
## v0.9.1 / 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## v0.9.0 / 2014-01-17
|
|
||||||
|
|
||||||
* IsAttrib() for events that only concern a file's metadata [#79][] (thanks @abustany)
|
|
||||||
* [Fix] kqueue: fix deadlock [#77][] (thanks @cespare)
|
|
||||||
* [NOTICE] Development has moved to `code.google.com/p/go.exp/fsnotify` in preparation for inclusion in the Go standard library.
|
|
||||||
|
|
||||||
## v0.8.12 / 2013-11-13
|
|
||||||
|
|
||||||
* [API] Remove FD_SET and friends from Linux adapter
|
|
||||||
|
|
||||||
## v0.8.11 / 2013-11-02
|
|
||||||
|
|
||||||
* [Doc] Add Changelog [#72][] (thanks @nathany)
|
|
||||||
* [Doc] Spotlight and double modify events on macOS [#62][] (reported by @paulhammond)
|
|
||||||
|
|
||||||
## v0.8.10 / 2013-10-19
|
|
||||||
|
|
||||||
* [Fix] kqueue: remove file watches when parent directory is removed [#71][] (reported by @mdwhatcott)
|
|
||||||
* [Fix] kqueue: race between Close and readEvents [#70][] (reported by @bernerdschaefer)
|
|
||||||
* [Doc] specify OS-specific limits in README (thanks @debrando)
|
|
||||||
|
|
||||||
## v0.8.9 / 2013-09-08
|
|
||||||
|
|
||||||
* [Doc] Contributing (thanks @nathany)
|
|
||||||
* [Doc] update package path in example code [#63][] (thanks @paulhammond)
|
|
||||||
* [Doc] GoCI badge in README (Linux only) [#60][]
|
|
||||||
* [Doc] Cross-platform testing with Vagrant [#59][] (thanks @nathany)
|
|
||||||
|
|
||||||
## v0.8.8 / 2013-06-17
|
|
||||||
|
|
||||||
* [Fix] Windows: handle `ERROR_MORE_DATA` on Windows [#49][] (thanks @jbowtie)
|
|
||||||
|
|
||||||
## v0.8.7 / 2013-06-03
|
|
||||||
|
|
||||||
* [API] Make syscall flags internal
|
|
||||||
* [Fix] inotify: ignore event changes
|
|
||||||
* [Fix] race in symlink test [#45][] (reported by @srid)
|
|
||||||
* [Fix] tests on Windows
|
|
||||||
* lower case error messages
|
|
||||||
|
|
||||||
## v0.8.6 / 2013-05-23
|
|
||||||
|
|
||||||
* kqueue: Use EVT_ONLY flag on Darwin
|
|
||||||
* [Doc] Update README with full example
|
|
||||||
|
|
||||||
## v0.8.5 / 2013-05-09
|
|
||||||
|
|
||||||
* [Fix] inotify: allow monitoring of "broken" symlinks (thanks @tsg)
|
|
||||||
|
|
||||||
## v0.8.4 / 2013-04-07
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch all file events [#40][] (thanks @ChrisBuchholz)
|
|
||||||
|
|
||||||
## v0.8.3 / 2013-03-13
|
|
||||||
|
|
||||||
* [Fix] inoitfy/kqueue memory leak [#36][] (reported by @nbkolchin)
|
|
||||||
* [Fix] kqueue: use fsnFlags for watching a directory [#33][] (reported by @nbkolchin)
|
|
||||||
|
|
||||||
## v0.8.2 / 2013-02-07
|
|
||||||
|
|
||||||
* [Doc] add Authors
|
|
||||||
* [Fix] fix data races for map access [#29][] (thanks @fsouza)
|
|
||||||
|
|
||||||
## v0.8.1 / 2013-01-09
|
|
||||||
|
|
||||||
* [Fix] Windows path separators
|
|
||||||
* [Doc] BSD License
|
|
||||||
|
|
||||||
## v0.8.0 / 2012-11-09
|
|
||||||
|
|
||||||
* kqueue: directory watching improvements (thanks @vmirage)
|
|
||||||
* inotify: add `IN_MOVED_TO` [#25][] (requested by @cpisto)
|
|
||||||
* [Fix] kqueue: deleting watched directory [#24][] (reported by @jakerr)
|
|
||||||
|
|
||||||
## v0.7.4 / 2012-10-09
|
|
||||||
|
|
||||||
* [Fix] inotify: fixes from https://codereview.appspot.com/5418045/ (ugorji)
|
|
||||||
* [Fix] kqueue: preserve watch flags when watching for delete [#21][] (reported by @robfig)
|
|
||||||
* [Fix] kqueue: watch the directory even if it isn't a new watch (thanks @robfig)
|
|
||||||
* [Fix] kqueue: modify after recreation of file
|
|
||||||
|
|
||||||
## v0.7.3 / 2012-09-27
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch with an existing folder inside the watched folder (thanks @vmirage)
|
|
||||||
* [Fix] kqueue: no longer get duplicate CREATE events
|
|
||||||
|
|
||||||
## v0.7.2 / 2012-09-01
|
|
||||||
|
|
||||||
* kqueue: events for created directories
|
|
||||||
|
|
||||||
## v0.7.1 / 2012-07-14
|
|
||||||
|
|
||||||
* [Fix] for renaming files
|
|
||||||
|
|
||||||
## v0.7.0 / 2012-07-02
|
|
||||||
|
|
||||||
* [Feature] FSNotify flags
|
|
||||||
* [Fix] inotify: Added file name back to event path
|
|
||||||
|
|
||||||
## v0.6.0 / 2012-06-06
|
|
||||||
|
|
||||||
* kqueue: watch files after directory created (thanks @tmc)
|
|
||||||
|
|
||||||
## v0.5.1 / 2012-05-22
|
|
||||||
|
|
||||||
* [Fix] inotify: remove all watches before Close()
|
|
||||||
|
|
||||||
## v0.5.0 / 2012-05-03
|
|
||||||
|
|
||||||
* [API] kqueue: return errors during watch instead of sending over channel
|
|
||||||
* kqueue: match symlink behavior on Linux
|
|
||||||
* inotify: add `DELETE_SELF` (requested by @taralx)
|
|
||||||
* [Fix] kqueue: handle EINTR (reported by @robfig)
|
|
||||||
* [Doc] Godoc example [#1][] (thanks @davecheney)
|
|
||||||
|
|
||||||
## v0.4.0 / 2012-03-30
|
|
||||||
|
|
||||||
* Go 1 released: build with go tool
|
|
||||||
* [Feature] Windows support using winfsnotify
|
|
||||||
* Windows does not have attribute change notifications
|
|
||||||
* Roll attribute notifications into IsModify
|
|
||||||
|
|
||||||
## v0.3.0 / 2012-02-19
|
|
||||||
|
|
||||||
* kqueue: add files when watch directory
|
|
||||||
|
|
||||||
## v0.2.0 / 2011-12-30
|
|
||||||
|
|
||||||
* update to latest Go weekly code
|
|
||||||
|
|
||||||
## v0.1.0 / 2011-10-19
|
|
||||||
|
|
||||||
* kqueue: add watch on file creation to match inotify
|
|
||||||
* kqueue: create file event
|
|
||||||
* inotify: ignore `IN_IGNORED` events
|
|
||||||
* event String()
|
|
||||||
* linux: common FileEvent functions
|
|
||||||
* initial commit
|
|
||||||
|
|
||||||
[#79]: https://github.com/howeyc/fsnotify/pull/79
|
|
||||||
[#77]: https://github.com/howeyc/fsnotify/pull/77
|
|
||||||
[#72]: https://github.com/howeyc/fsnotify/issues/72
|
|
||||||
[#71]: https://github.com/howeyc/fsnotify/issues/71
|
|
||||||
[#70]: https://github.com/howeyc/fsnotify/issues/70
|
|
||||||
[#63]: https://github.com/howeyc/fsnotify/issues/63
|
|
||||||
[#62]: https://github.com/howeyc/fsnotify/issues/62
|
|
||||||
[#60]: https://github.com/howeyc/fsnotify/issues/60
|
|
||||||
[#59]: https://github.com/howeyc/fsnotify/issues/59
|
|
||||||
[#49]: https://github.com/howeyc/fsnotify/issues/49
|
|
||||||
[#45]: https://github.com/howeyc/fsnotify/issues/45
|
|
||||||
[#40]: https://github.com/howeyc/fsnotify/issues/40
|
|
||||||
[#36]: https://github.com/howeyc/fsnotify/issues/36
|
|
||||||
[#33]: https://github.com/howeyc/fsnotify/issues/33
|
|
||||||
[#29]: https://github.com/howeyc/fsnotify/issues/29
|
|
||||||
[#25]: https://github.com/howeyc/fsnotify/issues/25
|
|
||||||
[#24]: https://github.com/howeyc/fsnotify/issues/24
|
|
||||||
[#21]: https://github.com/howeyc/fsnotify/issues/21
|
|
77
vendor/github.com/fsnotify/fsnotify/CONTRIBUTING.md
generated
vendored
77
vendor/github.com/fsnotify/fsnotify/CONTRIBUTING.md
generated
vendored
|
@ -1,77 +0,0 @@
|
||||||
# Contributing
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
|
|
||||||
* Request features and report bugs using the [GitHub Issue Tracker](https://github.com/fsnotify/fsnotify/issues).
|
|
||||||
* Please indicate the platform you are using fsnotify on.
|
|
||||||
* A code example to reproduce the problem is appreciated.
|
|
||||||
|
|
||||||
## Pull Requests
|
|
||||||
|
|
||||||
### Contributor License Agreement
|
|
||||||
|
|
||||||
fsnotify is derived from code in the [golang.org/x/exp](https://godoc.org/golang.org/x/exp) package and it may be included [in the standard library](https://github.com/fsnotify/fsnotify/issues/1) in the future. Therefore fsnotify carries the same [LICENSE](https://github.com/fsnotify/fsnotify/blob/master/LICENSE) as Go. Contributors retain their copyright, so you need to fill out a short form before we can accept your contribution: [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual).
|
|
||||||
|
|
||||||
Please indicate that you have signed the CLA in your pull request.
|
|
||||||
|
|
||||||
### How fsnotify is Developed
|
|
||||||
|
|
||||||
* Development is done on feature branches.
|
|
||||||
* Tests are run on BSD, Linux, macOS and Windows.
|
|
||||||
* Pull requests are reviewed and [applied to master][am] using [hub][].
|
|
||||||
* Maintainers may modify or squash commits rather than asking contributors to.
|
|
||||||
* To issue a new release, the maintainers will:
|
|
||||||
* Update the CHANGELOG
|
|
||||||
* Tag a version, which will become available through gopkg.in.
|
|
||||||
|
|
||||||
### How to Fork
|
|
||||||
|
|
||||||
For smooth sailing, always use the original import path. Installing with `go get` makes this easy.
|
|
||||||
|
|
||||||
1. Install from GitHub (`go get -u github.com/fsnotify/fsnotify`)
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Ensure everything works and the tests pass (see below)
|
|
||||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
|
|
||||||
Contribute upstream:
|
|
||||||
|
|
||||||
1. Fork fsnotify on GitHub
|
|
||||||
2. Add your remote (`git remote add fork git@github.com:mycompany/repo.git`)
|
|
||||||
3. Push to the branch (`git push fork my-new-feature`)
|
|
||||||
4. Create a new Pull Request on GitHub
|
|
||||||
|
|
||||||
This workflow is [thoroughly explained by Katrina Owen](https://splice.com/blog/contributing-open-source-git-repositories-go/).
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
fsnotify uses build tags to compile different code on Linux, BSD, macOS, and Windows.
|
|
||||||
|
|
||||||
Before doing a pull request, please do your best to test your changes on multiple platforms, and list which platforms you were able/unable to test on.
|
|
||||||
|
|
||||||
To aid in cross-platform testing there is a Vagrantfile for Linux and BSD.
|
|
||||||
|
|
||||||
* Install [Vagrant](http://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/)
|
|
||||||
* Setup [Vagrant Gopher](https://github.com/nathany/vagrant-gopher) in your `src` folder.
|
|
||||||
* Run `vagrant up` from the project folder. You can also setup just one box with `vagrant up linux` or `vagrant up bsd` (note: the BSD box doesn't support Windows hosts at this time, and NFS may prompt for your host OS password)
|
|
||||||
* Once setup, you can run the test suite on a given OS with a single command `vagrant ssh linux -c 'cd fsnotify/fsnotify; go test'`.
|
|
||||||
* When you're done, you will want to halt or destroy the Vagrant boxes.
|
|
||||||
|
|
||||||
Notice: fsnotify file system events won't trigger in shared folders. The tests get around this limitation by using the /tmp directory.
|
|
||||||
|
|
||||||
Right now there is no equivalent solution for Windows and macOS, but there are Windows VMs [freely available from Microsoft](http://www.modern.ie/en-us/virtualization-tools#downloads).
|
|
||||||
|
|
||||||
### Maintainers
|
|
||||||
|
|
||||||
Help maintaining fsnotify is welcome. To be a maintainer:
|
|
||||||
|
|
||||||
* Submit a pull request and sign the CLA as above.
|
|
||||||
* You must be able to run the test suite on Mac, Windows, Linux and BSD.
|
|
||||||
|
|
||||||
To keep master clean, the fsnotify project uses the "apply mail" workflow outlined in Nathaniel Talbott's post ["Merge pull request" Considered Harmful][am]. This requires installing [hub][].
|
|
||||||
|
|
||||||
All code changes should be internal pull requests.
|
|
||||||
|
|
||||||
Releases are tagged using [Semantic Versioning](http://semver.org/).
|
|
||||||
|
|
||||||
[hub]: https://github.com/github/hub
|
|
||||||
[am]: http://blog.spreedly.com/2014/06/24/merge-pull-request-considered-harmful/#.VGa5yZPF_Zs
|
|
28
vendor/github.com/fsnotify/fsnotify/LICENSE
generated
vendored
28
vendor/github.com/fsnotify/fsnotify/LICENSE
generated
vendored
|
@ -1,28 +0,0 @@
|
||||||
Copyright (c) 2012 The Go Authors. All rights reserved.
|
|
||||||
Copyright (c) 2012 fsnotify Authors. All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are
|
|
||||||
met:
|
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright
|
|
||||||
notice, this list of conditions and the following disclaimer.
|
|
||||||
* Redistributions in binary form must reproduce the above
|
|
||||||
copyright notice, this list of conditions and the following disclaimer
|
|
||||||
in the documentation and/or other materials provided with the
|
|
||||||
distribution.
|
|
||||||
* Neither the name of Google Inc. nor the names of its
|
|
||||||
contributors may be used to endorse or promote products derived from
|
|
||||||
this software without specific prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
||||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
||||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
||||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
||||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
||||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
79
vendor/github.com/fsnotify/fsnotify/README.md
generated
vendored
79
vendor/github.com/fsnotify/fsnotify/README.md
generated
vendored
|
@ -1,79 +0,0 @@
|
||||||
# File system notifications for Go
|
|
||||||
|
|
||||||
[![GoDoc](https://godoc.org/github.com/fsnotify/fsnotify?status.svg)](https://godoc.org/github.com/fsnotify/fsnotify) [![Go Report Card](https://goreportcard.com/badge/github.com/fsnotify/fsnotify)](https://goreportcard.com/report/github.com/fsnotify/fsnotify)
|
|
||||||
|
|
||||||
fsnotify utilizes [golang.org/x/sys](https://godoc.org/golang.org/x/sys) rather than `syscall` from the standard library. Ensure you have the latest version installed by running:
|
|
||||||
|
|
||||||
```console
|
|
||||||
go get -u golang.org/x/sys/...
|
|
||||||
```
|
|
||||||
|
|
||||||
Cross platform: Windows, Linux, BSD and macOS.
|
|
||||||
|
|
||||||
|Adapter |OS |Status |
|
|
||||||
|----------|----------|----------|
|
|
||||||
|inotify |Linux 2.6.27 or later, Android\*|Supported [![Build Status](https://travis-ci.org/fsnotify/fsnotify.svg?branch=master)](https://travis-ci.org/fsnotify/fsnotify)|
|
|
||||||
|kqueue |BSD, macOS, iOS\*|Supported [![Build Status](https://travis-ci.org/fsnotify/fsnotify.svg?branch=master)](https://travis-ci.org/fsnotify/fsnotify)|
|
|
||||||
|ReadDirectoryChangesW|Windows|Supported [![Build status](https://ci.appveyor.com/api/projects/status/ivwjubaih4r0udeh/branch/master?svg=true)](https://ci.appveyor.com/project/NathanYoungman/fsnotify/branch/master)|
|
|
||||||
|FSEvents |macOS |[Planned](https://github.com/fsnotify/fsnotify/issues/11)|
|
|
||||||
|FEN |Solaris 11 |[In Progress](https://github.com/fsnotify/fsnotify/issues/12)|
|
|
||||||
|fanotify |Linux 2.6.37+ | |
|
|
||||||
|USN Journals |Windows |[Maybe](https://github.com/fsnotify/fsnotify/issues/53)|
|
|
||||||
|Polling |*All* |[Maybe](https://github.com/fsnotify/fsnotify/issues/9)|
|
|
||||||
|
|
||||||
\* Android and iOS are untested.
|
|
||||||
|
|
||||||
Please see [the documentation](https://godoc.org/github.com/fsnotify/fsnotify) and consult the [FAQ](#faq) for usage information.
|
|
||||||
|
|
||||||
## API stability
|
|
||||||
|
|
||||||
fsnotify is a fork of [howeyc/fsnotify](https://godoc.org/github.com/howeyc/fsnotify) with a new API as of v1.0. The API is based on [this design document](http://goo.gl/MrYxyA).
|
|
||||||
|
|
||||||
All [releases](https://github.com/fsnotify/fsnotify/releases) are tagged based on [Semantic Versioning](http://semver.org/). Further API changes are [planned](https://github.com/fsnotify/fsnotify/milestones), and will be tagged with a new major revision number.
|
|
||||||
|
|
||||||
Go 1.6 supports dependencies located in the `vendor/` folder. Unless you are creating a library, it is recommended that you copy fsnotify into `vendor/github.com/fsnotify/fsnotify` within your project, and likewise for `golang.org/x/sys`.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Please refer to [CONTRIBUTING][] before opening an issue or pull request.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
See [example_test.go](https://github.com/fsnotify/fsnotify/blob/master/example_test.go).
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
**When a file is moved to another directory is it still being watched?**
|
|
||||||
|
|
||||||
No (it shouldn't be, unless you are watching where it was moved to).
|
|
||||||
|
|
||||||
**When I watch a directory, are all subdirectories watched as well?**
|
|
||||||
|
|
||||||
No, you must add watches for any directory you want to watch (a recursive watcher is on the roadmap [#18][]).
|
|
||||||
|
|
||||||
**Do I have to watch the Error and Event channels in a separate goroutine?**
|
|
||||||
|
|
||||||
As of now, yes. Looking into making this single-thread friendly (see [howeyc #7][#7])
|
|
||||||
|
|
||||||
**Why am I receiving multiple events for the same file on OS X?**
|
|
||||||
|
|
||||||
Spotlight indexing on OS X can result in multiple events (see [howeyc #62][#62]). A temporary workaround is to add your folder(s) to the *Spotlight Privacy settings* until we have a native FSEvents implementation (see [#11][]).
|
|
||||||
|
|
||||||
**How many files can be watched at once?**
|
|
||||||
|
|
||||||
There are OS-specific limits as to how many watches can be created:
|
|
||||||
* Linux: /proc/sys/fs/inotify/max_user_watches contains the limit, reaching this limit results in a "no space left on device" error.
|
|
||||||
* BSD / OSX: sysctl variables "kern.maxfiles" and "kern.maxfilesperproc", reaching these limits results in a "too many open files" error.
|
|
||||||
|
|
||||||
[#62]: https://github.com/howeyc/fsnotify/issues/62
|
|
||||||
[#18]: https://github.com/fsnotify/fsnotify/issues/18
|
|
||||||
[#11]: https://github.com/fsnotify/fsnotify/issues/11
|
|
||||||
[#7]: https://github.com/howeyc/fsnotify/issues/7
|
|
||||||
|
|
||||||
[contributing]: https://github.com/fsnotify/fsnotify/blob/master/CONTRIBUTING.md
|
|
||||||
|
|
||||||
## Related Projects
|
|
||||||
|
|
||||||
* [notify](https://github.com/rjeczalik/notify)
|
|
||||||
* [fsevents](https://github.com/fsnotify/fsevents)
|
|
||||||
|
|
37
vendor/github.com/fsnotify/fsnotify/fen.go
generated
vendored
37
vendor/github.com/fsnotify/fsnotify/fen.go
generated
vendored
|
@ -1,37 +0,0 @@
|
||||||
// Copyright 2010 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build solaris
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Watcher watches a set of files, delivering events to a channel.
|
|
||||||
type Watcher struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.
|
|
||||||
func NewWatcher() (*Watcher, error) {
|
|
||||||
return nil, errors.New("FEN based watcher not yet supported for fsnotify\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close removes all watches and closes the events channel.
|
|
||||||
func (w *Watcher) Close() error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add starts watching the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Add(name string) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove stops watching the the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Remove(name string) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
66
vendor/github.com/fsnotify/fsnotify/fsnotify.go
generated
vendored
66
vendor/github.com/fsnotify/fsnotify/fsnotify.go
generated
vendored
|
@ -1,66 +0,0 @@
|
||||||
// Copyright 2012 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !plan9
|
|
||||||
|
|
||||||
// Package fsnotify provides a platform-independent interface for file system notifications.
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Event represents a single file system notification.
|
|
||||||
type Event struct {
|
|
||||||
Name string // Relative path to the file or directory.
|
|
||||||
Op Op // File operation that triggered the event.
|
|
||||||
}
|
|
||||||
|
|
||||||
// Op describes a set of file operations.
|
|
||||||
type Op uint32
|
|
||||||
|
|
||||||
// These are the generalized file operations that can trigger a notification.
|
|
||||||
const (
|
|
||||||
Create Op = 1 << iota
|
|
||||||
Write
|
|
||||||
Remove
|
|
||||||
Rename
|
|
||||||
Chmod
|
|
||||||
)
|
|
||||||
|
|
||||||
func (op Op) String() string {
|
|
||||||
// Use a buffer for efficient string concatenation
|
|
||||||
var buffer bytes.Buffer
|
|
||||||
|
|
||||||
if op&Create == Create {
|
|
||||||
buffer.WriteString("|CREATE")
|
|
||||||
}
|
|
||||||
if op&Remove == Remove {
|
|
||||||
buffer.WriteString("|REMOVE")
|
|
||||||
}
|
|
||||||
if op&Write == Write {
|
|
||||||
buffer.WriteString("|WRITE")
|
|
||||||
}
|
|
||||||
if op&Rename == Rename {
|
|
||||||
buffer.WriteString("|RENAME")
|
|
||||||
}
|
|
||||||
if op&Chmod == Chmod {
|
|
||||||
buffer.WriteString("|CHMOD")
|
|
||||||
}
|
|
||||||
if buffer.Len() == 0 {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return buffer.String()[1:] // Strip leading pipe
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns a string representation of the event in the form
|
|
||||||
// "file: REMOVE|WRITE|..."
|
|
||||||
func (e Event) String() string {
|
|
||||||
return fmt.Sprintf("%q: %s", e.Name, e.Op.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Common errors that can be reported by a watcher
|
|
||||||
var ErrEventOverflow = errors.New("fsnotify queue overflow")
|
|
337
vendor/github.com/fsnotify/fsnotify/inotify.go
generated
vendored
337
vendor/github.com/fsnotify/fsnotify/inotify.go
generated
vendored
|
@ -1,337 +0,0 @@
|
||||||
// Copyright 2010 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build linux
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"unsafe"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Watcher watches a set of files, delivering events to a channel.
|
|
||||||
type Watcher struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
mu sync.Mutex // Map access
|
|
||||||
fd int
|
|
||||||
poller *fdPoller
|
|
||||||
watches map[string]*watch // Map of inotify watches (key: path)
|
|
||||||
paths map[int]string // Map of watched paths (key: watch descriptor)
|
|
||||||
done chan struct{} // Channel for sending a "quit message" to the reader goroutine
|
|
||||||
doneResp chan struct{} // Channel to respond to Close
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.
|
|
||||||
func NewWatcher() (*Watcher, error) {
|
|
||||||
// Create inotify fd
|
|
||||||
fd, errno := unix.InotifyInit1(unix.IN_CLOEXEC)
|
|
||||||
if fd == -1 {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
// Create epoll
|
|
||||||
poller, err := newFdPoller(fd)
|
|
||||||
if err != nil {
|
|
||||||
unix.Close(fd)
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
w := &Watcher{
|
|
||||||
fd: fd,
|
|
||||||
poller: poller,
|
|
||||||
watches: make(map[string]*watch),
|
|
||||||
paths: make(map[int]string),
|
|
||||||
Events: make(chan Event),
|
|
||||||
Errors: make(chan error),
|
|
||||||
done: make(chan struct{}),
|
|
||||||
doneResp: make(chan struct{}),
|
|
||||||
}
|
|
||||||
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Watcher) isClosed() bool {
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
return true
|
|
||||||
default:
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close removes all watches and closes the events channel.
|
|
||||||
func (w *Watcher) Close() error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send 'close' signal to goroutine, and set the Watcher to closed.
|
|
||||||
close(w.done)
|
|
||||||
|
|
||||||
// Wake up goroutine
|
|
||||||
w.poller.wake()
|
|
||||||
|
|
||||||
// Wait for goroutine to close
|
|
||||||
<-w.doneResp
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add starts watching the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Add(name string) error {
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
if w.isClosed() {
|
|
||||||
return errors.New("inotify instance already closed")
|
|
||||||
}
|
|
||||||
|
|
||||||
const agnosticEvents = unix.IN_MOVED_TO | unix.IN_MOVED_FROM |
|
|
||||||
unix.IN_CREATE | unix.IN_ATTRIB | unix.IN_MODIFY |
|
|
||||||
unix.IN_MOVE_SELF | unix.IN_DELETE | unix.IN_DELETE_SELF
|
|
||||||
|
|
||||||
var flags uint32 = agnosticEvents
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
watchEntry := w.watches[name]
|
|
||||||
if watchEntry != nil {
|
|
||||||
flags |= watchEntry.flags | unix.IN_MASK_ADD
|
|
||||||
}
|
|
||||||
wd, errno := unix.InotifyAddWatch(w.fd, name, flags)
|
|
||||||
if wd == -1 {
|
|
||||||
return errno
|
|
||||||
}
|
|
||||||
|
|
||||||
if watchEntry == nil {
|
|
||||||
w.watches[name] = &watch{wd: uint32(wd), flags: flags}
|
|
||||||
w.paths[wd] = name
|
|
||||||
} else {
|
|
||||||
watchEntry.wd = uint32(wd)
|
|
||||||
watchEntry.flags = flags
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove stops watching the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Remove(name string) error {
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
|
|
||||||
// Fetch the watch.
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
watch, ok := w.watches[name]
|
|
||||||
|
|
||||||
// Remove it from inotify.
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("can't remove non-existent inotify watch for: %s", name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// We successfully removed the watch if InotifyRmWatch doesn't return an
|
|
||||||
// error, we need to clean up our internal state to ensure it matches
|
|
||||||
// inotify's kernel state.
|
|
||||||
delete(w.paths, int(watch.wd))
|
|
||||||
delete(w.watches, name)
|
|
||||||
|
|
||||||
// inotify_rm_watch will return EINVAL if the file has been deleted;
|
|
||||||
// the inotify will already have been removed.
|
|
||||||
// watches and pathes are deleted in ignoreLinux() implicitly and asynchronously
|
|
||||||
// by calling inotify_rm_watch() below. e.g. readEvents() goroutine receives IN_IGNORE
|
|
||||||
// so that EINVAL means that the wd is being rm_watch()ed or its file removed
|
|
||||||
// by another thread and we have not received IN_IGNORE event.
|
|
||||||
success, errno := unix.InotifyRmWatch(w.fd, watch.wd)
|
|
||||||
if success == -1 {
|
|
||||||
// TODO: Perhaps it's not helpful to return an error here in every case.
|
|
||||||
// the only two possible errors are:
|
|
||||||
// EBADF, which happens when w.fd is not a valid file descriptor of any kind.
|
|
||||||
// EINVAL, which is when fd is not an inotify descriptor or wd is not a valid watch descriptor.
|
|
||||||
// Watch descriptors are invalidated when they are removed explicitly or implicitly;
|
|
||||||
// explicitly by inotify_rm_watch, implicitly when the file they are watching is deleted.
|
|
||||||
return errno
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type watch struct {
|
|
||||||
wd uint32 // Watch descriptor (as returned by the inotify_add_watch() syscall)
|
|
||||||
flags uint32 // inotify flags of this watch (see inotify(7) for the list of valid flags)
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from the inotify file descriptor, converts the
|
|
||||||
// received events into Event objects and sends them via the Events channel
|
|
||||||
func (w *Watcher) readEvents() {
|
|
||||||
var (
|
|
||||||
buf [unix.SizeofInotifyEvent * 4096]byte // Buffer for a maximum of 4096 raw events
|
|
||||||
n int // Number of bytes read with read()
|
|
||||||
errno error // Syscall errno
|
|
||||||
ok bool // For poller.wait
|
|
||||||
)
|
|
||||||
|
|
||||||
defer close(w.doneResp)
|
|
||||||
defer close(w.Errors)
|
|
||||||
defer close(w.Events)
|
|
||||||
defer unix.Close(w.fd)
|
|
||||||
defer w.poller.close()
|
|
||||||
|
|
||||||
for {
|
|
||||||
// See if we have been closed.
|
|
||||||
if w.isClosed() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
ok, errno = w.poller.wait()
|
|
||||||
if errno != nil {
|
|
||||||
select {
|
|
||||||
case w.Errors <- errno:
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if !ok {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
n, errno = unix.Read(w.fd, buf[:])
|
|
||||||
// If a signal interrupted execution, see if we've been asked to close, and try again.
|
|
||||||
// http://man7.org/linux/man-pages/man7/signal.7.html :
|
|
||||||
// "Before Linux 3.8, reads from an inotify(7) file descriptor were not restartable"
|
|
||||||
if errno == unix.EINTR {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// unix.Read might have been woken up by Close. If so, we're done.
|
|
||||||
if w.isClosed() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if n < unix.SizeofInotifyEvent {
|
|
||||||
var err error
|
|
||||||
if n == 0 {
|
|
||||||
// If EOF is received. This should really never happen.
|
|
||||||
err = io.EOF
|
|
||||||
} else if n < 0 {
|
|
||||||
// If an error occurred while reading.
|
|
||||||
err = errno
|
|
||||||
} else {
|
|
||||||
// Read was too short.
|
|
||||||
err = errors.New("notify: short read in readEvents()")
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case w.Errors <- err:
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
var offset uint32
|
|
||||||
// We don't know how many events we just read into the buffer
|
|
||||||
// While the offset points to at least one whole event...
|
|
||||||
for offset <= uint32(n-unix.SizeofInotifyEvent) {
|
|
||||||
// Point "raw" to the event in the buffer
|
|
||||||
raw := (*unix.InotifyEvent)(unsafe.Pointer(&buf[offset]))
|
|
||||||
|
|
||||||
mask := uint32(raw.Mask)
|
|
||||||
nameLen := uint32(raw.Len)
|
|
||||||
|
|
||||||
if mask&unix.IN_Q_OVERFLOW != 0 {
|
|
||||||
select {
|
|
||||||
case w.Errors <- ErrEventOverflow:
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the event happened to the watched directory or the watched file, the kernel
|
|
||||||
// doesn't append the filename to the event, but we would like to always fill the
|
|
||||||
// the "Name" field with a valid filename. We retrieve the path of the watch from
|
|
||||||
// the "paths" map.
|
|
||||||
w.mu.Lock()
|
|
||||||
name, ok := w.paths[int(raw.Wd)]
|
|
||||||
// IN_DELETE_SELF occurs when the file/directory being watched is removed.
|
|
||||||
// This is a sign to clean up the maps, otherwise we are no longer in sync
|
|
||||||
// with the inotify kernel state which has already deleted the watch
|
|
||||||
// automatically.
|
|
||||||
if ok && mask&unix.IN_DELETE_SELF == unix.IN_DELETE_SELF {
|
|
||||||
delete(w.paths, int(raw.Wd))
|
|
||||||
delete(w.watches, name)
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if nameLen > 0 {
|
|
||||||
// Point "bytes" at the first byte of the filename
|
|
||||||
bytes := (*[unix.PathMax]byte)(unsafe.Pointer(&buf[offset+unix.SizeofInotifyEvent]))
|
|
||||||
// The filename is padded with NULL bytes. TrimRight() gets rid of those.
|
|
||||||
name += "/" + strings.TrimRight(string(bytes[0:nameLen]), "\000")
|
|
||||||
}
|
|
||||||
|
|
||||||
event := newEvent(name, mask)
|
|
||||||
|
|
||||||
// Send the events that are not ignored on the events channel
|
|
||||||
if !event.ignoreLinux(mask) {
|
|
||||||
select {
|
|
||||||
case w.Events <- event:
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Move to the next event in the buffer
|
|
||||||
offset += unix.SizeofInotifyEvent + nameLen
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Certain types of events can be "ignored" and not sent over the Events
|
|
||||||
// channel. Such as events marked ignore by the kernel, or MODIFY events
|
|
||||||
// against files that do not exist.
|
|
||||||
func (e *Event) ignoreLinux(mask uint32) bool {
|
|
||||||
// Ignore anything the inotify API says to ignore
|
|
||||||
if mask&unix.IN_IGNORED == unix.IN_IGNORED {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the event is not a DELETE or RENAME, the file must exist.
|
|
||||||
// Otherwise the event is ignored.
|
|
||||||
// *Note*: this was put in place because it was seen that a MODIFY
|
|
||||||
// event was sent after the DELETE. This ignores that MODIFY and
|
|
||||||
// assumes a DELETE will come or has come if the file doesn't exist.
|
|
||||||
if !(e.Op&Remove == Remove || e.Op&Rename == Rename) {
|
|
||||||
_, statErr := os.Lstat(e.Name)
|
|
||||||
return os.IsNotExist(statErr)
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// newEvent returns an platform-independent Event based on an inotify mask.
|
|
||||||
func newEvent(name string, mask uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if mask&unix.IN_CREATE == unix.IN_CREATE || mask&unix.IN_MOVED_TO == unix.IN_MOVED_TO {
|
|
||||||
e.Op |= Create
|
|
||||||
}
|
|
||||||
if mask&unix.IN_DELETE_SELF == unix.IN_DELETE_SELF || mask&unix.IN_DELETE == unix.IN_DELETE {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&unix.IN_MODIFY == unix.IN_MODIFY {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&unix.IN_MOVE_SELF == unix.IN_MOVE_SELF || mask&unix.IN_MOVED_FROM == unix.IN_MOVED_FROM {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
if mask&unix.IN_ATTRIB == unix.IN_ATTRIB {
|
|
||||||
e.Op |= Chmod
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
187
vendor/github.com/fsnotify/fsnotify/inotify_poller.go
generated
vendored
187
vendor/github.com/fsnotify/fsnotify/inotify_poller.go
generated
vendored
|
@ -1,187 +0,0 @@
|
||||||
// Copyright 2015 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build linux
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fdPoller struct {
|
|
||||||
fd int // File descriptor (as returned by the inotify_init() syscall)
|
|
||||||
epfd int // Epoll file descriptor
|
|
||||||
pipe [2]int // Pipe for waking up
|
|
||||||
}
|
|
||||||
|
|
||||||
func emptyPoller(fd int) *fdPoller {
|
|
||||||
poller := new(fdPoller)
|
|
||||||
poller.fd = fd
|
|
||||||
poller.epfd = -1
|
|
||||||
poller.pipe[0] = -1
|
|
||||||
poller.pipe[1] = -1
|
|
||||||
return poller
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a new inotify poller.
|
|
||||||
// This creates an inotify handler, and an epoll handler.
|
|
||||||
func newFdPoller(fd int) (*fdPoller, error) {
|
|
||||||
var errno error
|
|
||||||
poller := emptyPoller(fd)
|
|
||||||
defer func() {
|
|
||||||
if errno != nil {
|
|
||||||
poller.close()
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
poller.fd = fd
|
|
||||||
|
|
||||||
// Create epoll fd
|
|
||||||
poller.epfd, errno = unix.EpollCreate1(0)
|
|
||||||
if poller.epfd == -1 {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
// Create pipe; pipe[0] is the read end, pipe[1] the write end.
|
|
||||||
errno = unix.Pipe2(poller.pipe[:], unix.O_NONBLOCK)
|
|
||||||
if errno != nil {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register inotify fd with epoll
|
|
||||||
event := unix.EpollEvent{
|
|
||||||
Fd: int32(poller.fd),
|
|
||||||
Events: unix.EPOLLIN,
|
|
||||||
}
|
|
||||||
errno = unix.EpollCtl(poller.epfd, unix.EPOLL_CTL_ADD, poller.fd, &event)
|
|
||||||
if errno != nil {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register pipe fd with epoll
|
|
||||||
event = unix.EpollEvent{
|
|
||||||
Fd: int32(poller.pipe[0]),
|
|
||||||
Events: unix.EPOLLIN,
|
|
||||||
}
|
|
||||||
errno = unix.EpollCtl(poller.epfd, unix.EPOLL_CTL_ADD, poller.pipe[0], &event)
|
|
||||||
if errno != nil {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
|
|
||||||
return poller, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wait using epoll.
|
|
||||||
// Returns true if something is ready to be read,
|
|
||||||
// false if there is not.
|
|
||||||
func (poller *fdPoller) wait() (bool, error) {
|
|
||||||
// 3 possible events per fd, and 2 fds, makes a maximum of 6 events.
|
|
||||||
// I don't know whether epoll_wait returns the number of events returned,
|
|
||||||
// or the total number of events ready.
|
|
||||||
// I decided to catch both by making the buffer one larger than the maximum.
|
|
||||||
events := make([]unix.EpollEvent, 7)
|
|
||||||
for {
|
|
||||||
n, errno := unix.EpollWait(poller.epfd, events, -1)
|
|
||||||
if n == -1 {
|
|
||||||
if errno == unix.EINTR {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return false, errno
|
|
||||||
}
|
|
||||||
if n == 0 {
|
|
||||||
// If there are no events, try again.
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if n > 6 {
|
|
||||||
// This should never happen. More events were returned than should be possible.
|
|
||||||
return false, errors.New("epoll_wait returned more events than I know what to do with")
|
|
||||||
}
|
|
||||||
ready := events[:n]
|
|
||||||
epollhup := false
|
|
||||||
epollerr := false
|
|
||||||
epollin := false
|
|
||||||
for _, event := range ready {
|
|
||||||
if event.Fd == int32(poller.fd) {
|
|
||||||
if event.Events&unix.EPOLLHUP != 0 {
|
|
||||||
// This should not happen, but if it does, treat it as a wakeup.
|
|
||||||
epollhup = true
|
|
||||||
}
|
|
||||||
if event.Events&unix.EPOLLERR != 0 {
|
|
||||||
// If an error is waiting on the file descriptor, we should pretend
|
|
||||||
// something is ready to read, and let unix.Read pick up the error.
|
|
||||||
epollerr = true
|
|
||||||
}
|
|
||||||
if event.Events&unix.EPOLLIN != 0 {
|
|
||||||
// There is data to read.
|
|
||||||
epollin = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if event.Fd == int32(poller.pipe[0]) {
|
|
||||||
if event.Events&unix.EPOLLHUP != 0 {
|
|
||||||
// Write pipe descriptor was closed, by us. This means we're closing down the
|
|
||||||
// watcher, and we should wake up.
|
|
||||||
}
|
|
||||||
if event.Events&unix.EPOLLERR != 0 {
|
|
||||||
// If an error is waiting on the pipe file descriptor.
|
|
||||||
// This is an absolute mystery, and should never ever happen.
|
|
||||||
return false, errors.New("Error on the pipe descriptor.")
|
|
||||||
}
|
|
||||||
if event.Events&unix.EPOLLIN != 0 {
|
|
||||||
// This is a regular wakeup, so we have to clear the buffer.
|
|
||||||
err := poller.clearWake()
|
|
||||||
if err != nil {
|
|
||||||
return false, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if epollhup || epollerr || epollin {
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close the write end of the poller.
|
|
||||||
func (poller *fdPoller) wake() error {
|
|
||||||
buf := make([]byte, 1)
|
|
||||||
n, errno := unix.Write(poller.pipe[1], buf)
|
|
||||||
if n == -1 {
|
|
||||||
if errno == unix.EAGAIN {
|
|
||||||
// Buffer is full, poller will wake.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return errno
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (poller *fdPoller) clearWake() error {
|
|
||||||
// You have to be woken up a LOT in order to get to 100!
|
|
||||||
buf := make([]byte, 100)
|
|
||||||
n, errno := unix.Read(poller.pipe[0], buf)
|
|
||||||
if n == -1 {
|
|
||||||
if errno == unix.EAGAIN {
|
|
||||||
// Buffer is empty, someone else cleared our wake.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return errno
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close all poller file descriptors, but not the one passed to it.
|
|
||||||
func (poller *fdPoller) close() {
|
|
||||||
if poller.pipe[1] != -1 {
|
|
||||||
unix.Close(poller.pipe[1])
|
|
||||||
}
|
|
||||||
if poller.pipe[0] != -1 {
|
|
||||||
unix.Close(poller.pipe[0])
|
|
||||||
}
|
|
||||||
if poller.epfd != -1 {
|
|
||||||
unix.Close(poller.epfd)
|
|
||||||
}
|
|
||||||
}
|
|
521
vendor/github.com/fsnotify/fsnotify/kqueue.go
generated
vendored
521
vendor/github.com/fsnotify/fsnotify/kqueue.go
generated
vendored
|
@ -1,521 +0,0 @@
|
||||||
// Copyright 2010 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build freebsd openbsd netbsd dragonfly darwin
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Watcher watches a set of files, delivering events to a channel.
|
|
||||||
type Watcher struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
done chan struct{} // Channel for sending a "quit message" to the reader goroutine
|
|
||||||
|
|
||||||
kq int // File descriptor (as returned by the kqueue() syscall).
|
|
||||||
|
|
||||||
mu sync.Mutex // Protects access to watcher data
|
|
||||||
watches map[string]int // Map of watched file descriptors (key: path).
|
|
||||||
externalWatches map[string]bool // Map of watches added by user of the library.
|
|
||||||
dirFlags map[string]uint32 // Map of watched directories to fflags used in kqueue.
|
|
||||||
paths map[int]pathInfo // Map file descriptors to path names for processing kqueue events.
|
|
||||||
fileExists map[string]bool // Keep track of if we know this file exists (to stop duplicate create events).
|
|
||||||
isClosed bool // Set to true when Close() is first called
|
|
||||||
}
|
|
||||||
|
|
||||||
type pathInfo struct {
|
|
||||||
name string
|
|
||||||
isDir bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.
|
|
||||||
func NewWatcher() (*Watcher, error) {
|
|
||||||
kq, err := kqueue()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
w := &Watcher{
|
|
||||||
kq: kq,
|
|
||||||
watches: make(map[string]int),
|
|
||||||
dirFlags: make(map[string]uint32),
|
|
||||||
paths: make(map[int]pathInfo),
|
|
||||||
fileExists: make(map[string]bool),
|
|
||||||
externalWatches: make(map[string]bool),
|
|
||||||
Events: make(chan Event),
|
|
||||||
Errors: make(chan error),
|
|
||||||
done: make(chan struct{}),
|
|
||||||
}
|
|
||||||
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close removes all watches and closes the events channel.
|
|
||||||
func (w *Watcher) Close() error {
|
|
||||||
w.mu.Lock()
|
|
||||||
if w.isClosed {
|
|
||||||
w.mu.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
w.isClosed = true
|
|
||||||
|
|
||||||
// copy paths to remove while locked
|
|
||||||
var pathsToRemove = make([]string, 0, len(w.watches))
|
|
||||||
for name := range w.watches {
|
|
||||||
pathsToRemove = append(pathsToRemove, name)
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
// unlock before calling Remove, which also locks
|
|
||||||
|
|
||||||
for _, name := range pathsToRemove {
|
|
||||||
w.Remove(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// send a "quit" message to the reader goroutine
|
|
||||||
close(w.done)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add starts watching the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Add(name string) error {
|
|
||||||
w.mu.Lock()
|
|
||||||
w.externalWatches[name] = true
|
|
||||||
w.mu.Unlock()
|
|
||||||
_, err := w.addWatch(name, noteAllEvents)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove stops watching the the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Remove(name string) error {
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
w.mu.Lock()
|
|
||||||
watchfd, ok := w.watches[name]
|
|
||||||
w.mu.Unlock()
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("can't remove non-existent kevent watch for: %s", name)
|
|
||||||
}
|
|
||||||
|
|
||||||
const registerRemove = unix.EV_DELETE
|
|
||||||
if err := register(w.kq, []int{watchfd}, registerRemove, 0); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
unix.Close(watchfd)
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
isDir := w.paths[watchfd].isDir
|
|
||||||
delete(w.watches, name)
|
|
||||||
delete(w.paths, watchfd)
|
|
||||||
delete(w.dirFlags, name)
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
// Find all watched paths that are in this directory that are not external.
|
|
||||||
if isDir {
|
|
||||||
var pathsToRemove []string
|
|
||||||
w.mu.Lock()
|
|
||||||
for _, path := range w.paths {
|
|
||||||
wdir, _ := filepath.Split(path.name)
|
|
||||||
if filepath.Clean(wdir) == name {
|
|
||||||
if !w.externalWatches[path.name] {
|
|
||||||
pathsToRemove = append(pathsToRemove, path.name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
for _, name := range pathsToRemove {
|
|
||||||
// Since these are internal, not much sense in propagating error
|
|
||||||
// to the user, as that will just confuse them with an error about
|
|
||||||
// a path they did not explicitly watch themselves.
|
|
||||||
w.Remove(name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Watch all events (except NOTE_EXTEND, NOTE_LINK, NOTE_REVOKE)
|
|
||||||
const noteAllEvents = unix.NOTE_DELETE | unix.NOTE_WRITE | unix.NOTE_ATTRIB | unix.NOTE_RENAME
|
|
||||||
|
|
||||||
// keventWaitTime to block on each read from kevent
|
|
||||||
var keventWaitTime = durationToTimespec(100 * time.Millisecond)
|
|
||||||
|
|
||||||
// addWatch adds name to the watched file set.
|
|
||||||
// The flags are interpreted as described in kevent(2).
|
|
||||||
// Returns the real path to the file which was added, if any, which may be different from the one passed in the case of symlinks.
|
|
||||||
func (w *Watcher) addWatch(name string, flags uint32) (string, error) {
|
|
||||||
var isDir bool
|
|
||||||
// Make ./name and name equivalent
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
if w.isClosed {
|
|
||||||
w.mu.Unlock()
|
|
||||||
return "", errors.New("kevent instance already closed")
|
|
||||||
}
|
|
||||||
watchfd, alreadyWatching := w.watches[name]
|
|
||||||
// We already have a watch, but we can still override flags.
|
|
||||||
if alreadyWatching {
|
|
||||||
isDir = w.paths[watchfd].isDir
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if !alreadyWatching {
|
|
||||||
fi, err := os.Lstat(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't watch sockets.
|
|
||||||
if fi.Mode()&os.ModeSocket == os.ModeSocket {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't watch named pipes.
|
|
||||||
if fi.Mode()&os.ModeNamedPipe == os.ModeNamedPipe {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Follow Symlinks
|
|
||||||
// Unfortunately, Linux can add bogus symlinks to watch list without
|
|
||||||
// issue, and Windows can't do symlinks period (AFAIK). To maintain
|
|
||||||
// consistency, we will act like everything is fine. There will simply
|
|
||||||
// be no file events for broken symlinks.
|
|
||||||
// Hence the returns of nil on errors.
|
|
||||||
if fi.Mode()&os.ModeSymlink == os.ModeSymlink {
|
|
||||||
name, err = filepath.EvalSymlinks(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
_, alreadyWatching = w.watches[name]
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if alreadyWatching {
|
|
||||||
return name, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
fi, err = os.Lstat(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
watchfd, err = unix.Open(name, openMode, 0700)
|
|
||||||
if watchfd == -1 {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
isDir = fi.IsDir()
|
|
||||||
}
|
|
||||||
|
|
||||||
const registerAdd = unix.EV_ADD | unix.EV_CLEAR | unix.EV_ENABLE
|
|
||||||
if err := register(w.kq, []int{watchfd}, registerAdd, flags); err != nil {
|
|
||||||
unix.Close(watchfd)
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !alreadyWatching {
|
|
||||||
w.mu.Lock()
|
|
||||||
w.watches[name] = watchfd
|
|
||||||
w.paths[watchfd] = pathInfo{name: name, isDir: isDir}
|
|
||||||
w.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
if isDir {
|
|
||||||
// Watch the directory if it has not been watched before,
|
|
||||||
// or if it was watched before, but perhaps only a NOTE_DELETE (watchDirectoryFiles)
|
|
||||||
w.mu.Lock()
|
|
||||||
|
|
||||||
watchDir := (flags&unix.NOTE_WRITE) == unix.NOTE_WRITE &&
|
|
||||||
(!alreadyWatching || (w.dirFlags[name]&unix.NOTE_WRITE) != unix.NOTE_WRITE)
|
|
||||||
// Store flags so this watch can be updated later
|
|
||||||
w.dirFlags[name] = flags
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if watchDir {
|
|
||||||
if err := w.watchDirectoryFiles(name); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return name, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from kqueue and converts the received kevents into
|
|
||||||
// Event values that it sends down the Events channel.
|
|
||||||
func (w *Watcher) readEvents() {
|
|
||||||
eventBuffer := make([]unix.Kevent_t, 10)
|
|
||||||
|
|
||||||
loop:
|
|
||||||
for {
|
|
||||||
// See if there is a message on the "done" channel
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
break loop
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get new events
|
|
||||||
kevents, err := read(w.kq, eventBuffer, &keventWaitTime)
|
|
||||||
// EINTR is okay, the syscall was interrupted before timeout expired.
|
|
||||||
if err != nil && err != unix.EINTR {
|
|
||||||
select {
|
|
||||||
case w.Errors <- err:
|
|
||||||
case <-w.done:
|
|
||||||
break loop
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Flush the events we received to the Events channel
|
|
||||||
for len(kevents) > 0 {
|
|
||||||
kevent := &kevents[0]
|
|
||||||
watchfd := int(kevent.Ident)
|
|
||||||
mask := uint32(kevent.Fflags)
|
|
||||||
w.mu.Lock()
|
|
||||||
path := w.paths[watchfd]
|
|
||||||
w.mu.Unlock()
|
|
||||||
event := newEvent(path.name, mask)
|
|
||||||
|
|
||||||
if path.isDir && !(event.Op&Remove == Remove) {
|
|
||||||
// Double check to make sure the directory exists. This can happen when
|
|
||||||
// we do a rm -fr on a recursively watched folders and we receive a
|
|
||||||
// modification event first but the folder has been deleted and later
|
|
||||||
// receive the delete event
|
|
||||||
if _, err := os.Lstat(event.Name); os.IsNotExist(err) {
|
|
||||||
// mark is as delete event
|
|
||||||
event.Op |= Remove
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if event.Op&Rename == Rename || event.Op&Remove == Remove {
|
|
||||||
w.Remove(event.Name)
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.fileExists, event.Name)
|
|
||||||
w.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
if path.isDir && event.Op&Write == Write && !(event.Op&Remove == Remove) {
|
|
||||||
w.sendDirectoryChangeEvents(event.Name)
|
|
||||||
} else {
|
|
||||||
// Send the event on the Events channel.
|
|
||||||
select {
|
|
||||||
case w.Events <- event:
|
|
||||||
case <-w.done:
|
|
||||||
break loop
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if event.Op&Remove == Remove {
|
|
||||||
// Look for a file that may have overwritten this.
|
|
||||||
// For example, mv f1 f2 will delete f2, then create f2.
|
|
||||||
if path.isDir {
|
|
||||||
fileDir := filepath.Clean(event.Name)
|
|
||||||
w.mu.Lock()
|
|
||||||
_, found := w.watches[fileDir]
|
|
||||||
w.mu.Unlock()
|
|
||||||
if found {
|
|
||||||
// make sure the directory exists before we watch for changes. When we
|
|
||||||
// do a recursive watch and perform rm -fr, the parent directory might
|
|
||||||
// have gone missing, ignore the missing directory and let the
|
|
||||||
// upcoming delete event remove the watch from the parent directory.
|
|
||||||
if _, err := os.Lstat(fileDir); err == nil {
|
|
||||||
w.sendDirectoryChangeEvents(fileDir)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
filePath := filepath.Clean(event.Name)
|
|
||||||
if fileInfo, err := os.Lstat(filePath); err == nil {
|
|
||||||
w.sendFileCreatedEventIfNew(filePath, fileInfo)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Move to next event
|
|
||||||
kevents = kevents[1:]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// cleanup
|
|
||||||
err := unix.Close(w.kq)
|
|
||||||
if err != nil {
|
|
||||||
// only way the previous loop breaks is if w.done was closed so we need to async send to w.Errors.
|
|
||||||
select {
|
|
||||||
case w.Errors <- err:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
}
|
|
||||||
close(w.Events)
|
|
||||||
close(w.Errors)
|
|
||||||
}
|
|
||||||
|
|
||||||
// newEvent returns an platform-independent Event based on kqueue Fflags.
|
|
||||||
func newEvent(name string, mask uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if mask&unix.NOTE_DELETE == unix.NOTE_DELETE {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_WRITE == unix.NOTE_WRITE {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_RENAME == unix.NOTE_RENAME {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_ATTRIB == unix.NOTE_ATTRIB {
|
|
||||||
e.Op |= Chmod
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
func newCreateEvent(name string) Event {
|
|
||||||
return Event{Name: name, Op: Create}
|
|
||||||
}
|
|
||||||
|
|
||||||
// watchDirectoryFiles to mimic inotify when adding a watch on a directory
|
|
||||||
func (w *Watcher) watchDirectoryFiles(dirPath string) error {
|
|
||||||
// Get all files
|
|
||||||
files, err := ioutil.ReadDir(dirPath)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, fileInfo := range files {
|
|
||||||
filePath := filepath.Join(dirPath, fileInfo.Name())
|
|
||||||
filePath, err = w.internalWatch(filePath, fileInfo)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
w.fileExists[filePath] = true
|
|
||||||
w.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendDirectoryEvents searches the directory for newly created files
|
|
||||||
// and sends them over the event channel. This functionality is to have
|
|
||||||
// the BSD version of fsnotify match Linux inotify which provides a
|
|
||||||
// create event for files created in a watched directory.
|
|
||||||
func (w *Watcher) sendDirectoryChangeEvents(dirPath string) {
|
|
||||||
// Get all files
|
|
||||||
files, err := ioutil.ReadDir(dirPath)
|
|
||||||
if err != nil {
|
|
||||||
select {
|
|
||||||
case w.Errors <- err:
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Search for new files
|
|
||||||
for _, fileInfo := range files {
|
|
||||||
filePath := filepath.Join(dirPath, fileInfo.Name())
|
|
||||||
err := w.sendFileCreatedEventIfNew(filePath, fileInfo)
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendFileCreatedEvent sends a create event if the file isn't already being tracked.
|
|
||||||
func (w *Watcher) sendFileCreatedEventIfNew(filePath string, fileInfo os.FileInfo) (err error) {
|
|
||||||
w.mu.Lock()
|
|
||||||
_, doesExist := w.fileExists[filePath]
|
|
||||||
w.mu.Unlock()
|
|
||||||
if !doesExist {
|
|
||||||
// Send create event
|
|
||||||
select {
|
|
||||||
case w.Events <- newCreateEvent(filePath):
|
|
||||||
case <-w.done:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// like watchDirectoryFiles (but without doing another ReadDir)
|
|
||||||
filePath, err = w.internalWatch(filePath, fileInfo)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
w.fileExists[filePath] = true
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Watcher) internalWatch(name string, fileInfo os.FileInfo) (string, error) {
|
|
||||||
if fileInfo.IsDir() {
|
|
||||||
// mimic Linux providing delete events for subdirectories
|
|
||||||
// but preserve the flags used if currently watching subdirectory
|
|
||||||
w.mu.Lock()
|
|
||||||
flags := w.dirFlags[name]
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
flags |= unix.NOTE_DELETE | unix.NOTE_RENAME
|
|
||||||
return w.addWatch(name, flags)
|
|
||||||
}
|
|
||||||
|
|
||||||
// watch file to mimic Linux inotify
|
|
||||||
return w.addWatch(name, noteAllEvents)
|
|
||||||
}
|
|
||||||
|
|
||||||
// kqueue creates a new kernel event queue and returns a descriptor.
|
|
||||||
func kqueue() (kq int, err error) {
|
|
||||||
kq, err = unix.Kqueue()
|
|
||||||
if kq == -1 {
|
|
||||||
return kq, err
|
|
||||||
}
|
|
||||||
return kq, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// register events with the queue
|
|
||||||
func register(kq int, fds []int, flags int, fflags uint32) error {
|
|
||||||
changes := make([]unix.Kevent_t, len(fds))
|
|
||||||
|
|
||||||
for i, fd := range fds {
|
|
||||||
// SetKevent converts int to the platform-specific types:
|
|
||||||
unix.SetKevent(&changes[i], fd, unix.EVFILT_VNODE, flags)
|
|
||||||
changes[i].Fflags = fflags
|
|
||||||
}
|
|
||||||
|
|
||||||
// register the events
|
|
||||||
success, err := unix.Kevent(kq, changes, nil, nil)
|
|
||||||
if success == -1 {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// read retrieves pending events, or waits until an event occurs.
|
|
||||||
// A timeout of nil blocks indefinitely, while 0 polls the queue.
|
|
||||||
func read(kq int, events []unix.Kevent_t, timeout *unix.Timespec) ([]unix.Kevent_t, error) {
|
|
||||||
n, err := unix.Kevent(kq, nil, events, timeout)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return events[0:n], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// durationToTimespec prepares a timeout value
|
|
||||||
func durationToTimespec(d time.Duration) unix.Timespec {
|
|
||||||
return unix.NsecToTimespec(d.Nanoseconds())
|
|
||||||
}
|
|
11
vendor/github.com/fsnotify/fsnotify/open_mode_bsd.go
generated
vendored
11
vendor/github.com/fsnotify/fsnotify/open_mode_bsd.go
generated
vendored
|
@ -1,11 +0,0 @@
|
||||||
// Copyright 2013 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build freebsd openbsd netbsd dragonfly
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
const openMode = unix.O_NONBLOCK | unix.O_RDONLY
|
|
12
vendor/github.com/fsnotify/fsnotify/open_mode_darwin.go
generated
vendored
12
vendor/github.com/fsnotify/fsnotify/open_mode_darwin.go
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
// Copyright 2013 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build darwin
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
// note: this constant is not defined on BSD
|
|
||||||
const openMode = unix.O_EVTONLY
|
|
561
vendor/github.com/fsnotify/fsnotify/windows.go
generated
vendored
561
vendor/github.com/fsnotify/fsnotify/windows.go
generated
vendored
|
@ -1,561 +0,0 @@
|
||||||
// Copyright 2011 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build windows
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"runtime"
|
|
||||||
"sync"
|
|
||||||
"syscall"
|
|
||||||
"unsafe"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Watcher watches a set of files, delivering events to a channel.
|
|
||||||
type Watcher struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
isClosed bool // Set to true when Close() is first called
|
|
||||||
mu sync.Mutex // Map access
|
|
||||||
port syscall.Handle // Handle to completion port
|
|
||||||
watches watchMap // Map of watches (key: i-number)
|
|
||||||
input chan *input // Inputs to the reader are sent on this channel
|
|
||||||
quit chan chan<- error
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.
|
|
||||||
func NewWatcher() (*Watcher, error) {
|
|
||||||
port, e := syscall.CreateIoCompletionPort(syscall.InvalidHandle, 0, 0, 0)
|
|
||||||
if e != nil {
|
|
||||||
return nil, os.NewSyscallError("CreateIoCompletionPort", e)
|
|
||||||
}
|
|
||||||
w := &Watcher{
|
|
||||||
port: port,
|
|
||||||
watches: make(watchMap),
|
|
||||||
input: make(chan *input, 1),
|
|
||||||
Events: make(chan Event, 50),
|
|
||||||
Errors: make(chan error),
|
|
||||||
quit: make(chan chan<- error, 1),
|
|
||||||
}
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close removes all watches and closes the events channel.
|
|
||||||
func (w *Watcher) Close() error {
|
|
||||||
if w.isClosed {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
w.isClosed = true
|
|
||||||
|
|
||||||
// Send "quit" message to the reader goroutine
|
|
||||||
ch := make(chan error)
|
|
||||||
w.quit <- ch
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-ch
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add starts watching the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Add(name string) error {
|
|
||||||
if w.isClosed {
|
|
||||||
return errors.New("watcher already closed")
|
|
||||||
}
|
|
||||||
in := &input{
|
|
||||||
op: opAddWatch,
|
|
||||||
path: filepath.Clean(name),
|
|
||||||
flags: sysFSALLEVENTS,
|
|
||||||
reply: make(chan error),
|
|
||||||
}
|
|
||||||
w.input <- in
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-in.reply
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove stops watching the the named file or directory (non-recursively).
|
|
||||||
func (w *Watcher) Remove(name string) error {
|
|
||||||
in := &input{
|
|
||||||
op: opRemoveWatch,
|
|
||||||
path: filepath.Clean(name),
|
|
||||||
reply: make(chan error),
|
|
||||||
}
|
|
||||||
w.input <- in
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-in.reply
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
// Options for AddWatch
|
|
||||||
sysFSONESHOT = 0x80000000
|
|
||||||
sysFSONLYDIR = 0x1000000
|
|
||||||
|
|
||||||
// Events
|
|
||||||
sysFSACCESS = 0x1
|
|
||||||
sysFSALLEVENTS = 0xfff
|
|
||||||
sysFSATTRIB = 0x4
|
|
||||||
sysFSCLOSE = 0x18
|
|
||||||
sysFSCREATE = 0x100
|
|
||||||
sysFSDELETE = 0x200
|
|
||||||
sysFSDELETESELF = 0x400
|
|
||||||
sysFSMODIFY = 0x2
|
|
||||||
sysFSMOVE = 0xc0
|
|
||||||
sysFSMOVEDFROM = 0x40
|
|
||||||
sysFSMOVEDTO = 0x80
|
|
||||||
sysFSMOVESELF = 0x800
|
|
||||||
|
|
||||||
// Special events
|
|
||||||
sysFSIGNORED = 0x8000
|
|
||||||
sysFSQOVERFLOW = 0x4000
|
|
||||||
)
|
|
||||||
|
|
||||||
func newEvent(name string, mask uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if mask&sysFSCREATE == sysFSCREATE || mask&sysFSMOVEDTO == sysFSMOVEDTO {
|
|
||||||
e.Op |= Create
|
|
||||||
}
|
|
||||||
if mask&sysFSDELETE == sysFSDELETE || mask&sysFSDELETESELF == sysFSDELETESELF {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&sysFSMODIFY == sysFSMODIFY {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&sysFSMOVE == sysFSMOVE || mask&sysFSMOVESELF == sysFSMOVESELF || mask&sysFSMOVEDFROM == sysFSMOVEDFROM {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
if mask&sysFSATTRIB == sysFSATTRIB {
|
|
||||||
e.Op |= Chmod
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
opAddWatch = iota
|
|
||||||
opRemoveWatch
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
provisional uint64 = 1 << (32 + iota)
|
|
||||||
)
|
|
||||||
|
|
||||||
type input struct {
|
|
||||||
op int
|
|
||||||
path string
|
|
||||||
flags uint32
|
|
||||||
reply chan error
|
|
||||||
}
|
|
||||||
|
|
||||||
type inode struct {
|
|
||||||
handle syscall.Handle
|
|
||||||
volume uint32
|
|
||||||
index uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
type watch struct {
|
|
||||||
ov syscall.Overlapped
|
|
||||||
ino *inode // i-number
|
|
||||||
path string // Directory path
|
|
||||||
mask uint64 // Directory itself is being watched with these notify flags
|
|
||||||
names map[string]uint64 // Map of names being watched and their notify flags
|
|
||||||
rename string // Remembers the old name while renaming a file
|
|
||||||
buf [4096]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
type indexMap map[uint64]*watch
|
|
||||||
type watchMap map[uint32]indexMap
|
|
||||||
|
|
||||||
func (w *Watcher) wakeupReader() error {
|
|
||||||
e := syscall.PostQueuedCompletionStatus(w.port, 0, 0, nil)
|
|
||||||
if e != nil {
|
|
||||||
return os.NewSyscallError("PostQueuedCompletionStatus", e)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func getDir(pathname string) (dir string, err error) {
|
|
||||||
attr, e := syscall.GetFileAttributes(syscall.StringToUTF16Ptr(pathname))
|
|
||||||
if e != nil {
|
|
||||||
return "", os.NewSyscallError("GetFileAttributes", e)
|
|
||||||
}
|
|
||||||
if attr&syscall.FILE_ATTRIBUTE_DIRECTORY != 0 {
|
|
||||||
dir = pathname
|
|
||||||
} else {
|
|
||||||
dir, _ = filepath.Split(pathname)
|
|
||||||
dir = filepath.Clean(dir)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func getIno(path string) (ino *inode, err error) {
|
|
||||||
h, e := syscall.CreateFile(syscall.StringToUTF16Ptr(path),
|
|
||||||
syscall.FILE_LIST_DIRECTORY,
|
|
||||||
syscall.FILE_SHARE_READ|syscall.FILE_SHARE_WRITE|syscall.FILE_SHARE_DELETE,
|
|
||||||
nil, syscall.OPEN_EXISTING,
|
|
||||||
syscall.FILE_FLAG_BACKUP_SEMANTICS|syscall.FILE_FLAG_OVERLAPPED, 0)
|
|
||||||
if e != nil {
|
|
||||||
return nil, os.NewSyscallError("CreateFile", e)
|
|
||||||
}
|
|
||||||
var fi syscall.ByHandleFileInformation
|
|
||||||
if e = syscall.GetFileInformationByHandle(h, &fi); e != nil {
|
|
||||||
syscall.CloseHandle(h)
|
|
||||||
return nil, os.NewSyscallError("GetFileInformationByHandle", e)
|
|
||||||
}
|
|
||||||
ino = &inode{
|
|
||||||
handle: h,
|
|
||||||
volume: fi.VolumeSerialNumber,
|
|
||||||
index: uint64(fi.FileIndexHigh)<<32 | uint64(fi.FileIndexLow),
|
|
||||||
}
|
|
||||||
return ino, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (m watchMap) get(ino *inode) *watch {
|
|
||||||
if i := m[ino.volume]; i != nil {
|
|
||||||
return i[ino.index]
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (m watchMap) set(ino *inode, watch *watch) {
|
|
||||||
i := m[ino.volume]
|
|
||||||
if i == nil {
|
|
||||||
i = make(indexMap)
|
|
||||||
m[ino.volume] = i
|
|
||||||
}
|
|
||||||
i[ino.index] = watch
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *Watcher) addWatch(pathname string, flags uint64) error {
|
|
||||||
dir, err := getDir(pathname)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if flags&sysFSONLYDIR != 0 && pathname != dir {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
ino, err := getIno(dir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
watchEntry := w.watches.get(ino)
|
|
||||||
w.mu.Unlock()
|
|
||||||
if watchEntry == nil {
|
|
||||||
if _, e := syscall.CreateIoCompletionPort(ino.handle, w.port, 0, 0); e != nil {
|
|
||||||
syscall.CloseHandle(ino.handle)
|
|
||||||
return os.NewSyscallError("CreateIoCompletionPort", e)
|
|
||||||
}
|
|
||||||
watchEntry = &watch{
|
|
||||||
ino: ino,
|
|
||||||
path: dir,
|
|
||||||
names: make(map[string]uint64),
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
w.watches.set(ino, watchEntry)
|
|
||||||
w.mu.Unlock()
|
|
||||||
flags |= provisional
|
|
||||||
} else {
|
|
||||||
syscall.CloseHandle(ino.handle)
|
|
||||||
}
|
|
||||||
if pathname == dir {
|
|
||||||
watchEntry.mask |= flags
|
|
||||||
} else {
|
|
||||||
watchEntry.names[filepath.Base(pathname)] |= flags
|
|
||||||
}
|
|
||||||
if err = w.startRead(watchEntry); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if pathname == dir {
|
|
||||||
watchEntry.mask &= ^provisional
|
|
||||||
} else {
|
|
||||||
watchEntry.names[filepath.Base(pathname)] &= ^provisional
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *Watcher) remWatch(pathname string) error {
|
|
||||||
dir, err := getDir(pathname)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
ino, err := getIno(dir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
watch := w.watches.get(ino)
|
|
||||||
w.mu.Unlock()
|
|
||||||
if watch == nil {
|
|
||||||
return fmt.Errorf("can't remove non-existent watch for: %s", pathname)
|
|
||||||
}
|
|
||||||
if pathname == dir {
|
|
||||||
w.sendEvent(watch.path, watch.mask&sysFSIGNORED)
|
|
||||||
watch.mask = 0
|
|
||||||
} else {
|
|
||||||
name := filepath.Base(pathname)
|
|
||||||
w.sendEvent(filepath.Join(watch.path, name), watch.names[name]&sysFSIGNORED)
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
return w.startRead(watch)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *Watcher) deleteWatch(watch *watch) {
|
|
||||||
for name, mask := range watch.names {
|
|
||||||
if mask&provisional == 0 {
|
|
||||||
w.sendEvent(filepath.Join(watch.path, name), mask&sysFSIGNORED)
|
|
||||||
}
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
if watch.mask != 0 {
|
|
||||||
if watch.mask&provisional == 0 {
|
|
||||||
w.sendEvent(watch.path, watch.mask&sysFSIGNORED)
|
|
||||||
}
|
|
||||||
watch.mask = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *Watcher) startRead(watch *watch) error {
|
|
||||||
if e := syscall.CancelIo(watch.ino.handle); e != nil {
|
|
||||||
w.Errors <- os.NewSyscallError("CancelIo", e)
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
}
|
|
||||||
mask := toWindowsFlags(watch.mask)
|
|
||||||
for _, m := range watch.names {
|
|
||||||
mask |= toWindowsFlags(m)
|
|
||||||
}
|
|
||||||
if mask == 0 {
|
|
||||||
if e := syscall.CloseHandle(watch.ino.handle); e != nil {
|
|
||||||
w.Errors <- os.NewSyscallError("CloseHandle", e)
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.watches[watch.ino.volume], watch.ino.index)
|
|
||||||
w.mu.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
e := syscall.ReadDirectoryChanges(watch.ino.handle, &watch.buf[0],
|
|
||||||
uint32(unsafe.Sizeof(watch.buf)), false, mask, nil, &watch.ov, 0)
|
|
||||||
if e != nil {
|
|
||||||
err := os.NewSyscallError("ReadDirectoryChanges", e)
|
|
||||||
if e == syscall.ERROR_ACCESS_DENIED && watch.mask&provisional == 0 {
|
|
||||||
// Watched directory was probably removed
|
|
||||||
if w.sendEvent(watch.path, watch.mask&sysFSDELETESELF) {
|
|
||||||
if watch.mask&sysFSONESHOT != 0 {
|
|
||||||
watch.mask = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from the I/O completion port, converts the
|
|
||||||
// received events into Event objects and sends them via the Events channel.
|
|
||||||
// Entry point to the I/O thread.
|
|
||||||
func (w *Watcher) readEvents() {
|
|
||||||
var (
|
|
||||||
n, key uint32
|
|
||||||
ov *syscall.Overlapped
|
|
||||||
)
|
|
||||||
runtime.LockOSThread()
|
|
||||||
|
|
||||||
for {
|
|
||||||
e := syscall.GetQueuedCompletionStatus(w.port, &n, &key, &ov, syscall.INFINITE)
|
|
||||||
watch := (*watch)(unsafe.Pointer(ov))
|
|
||||||
|
|
||||||
if watch == nil {
|
|
||||||
select {
|
|
||||||
case ch := <-w.quit:
|
|
||||||
w.mu.Lock()
|
|
||||||
var indexes []indexMap
|
|
||||||
for _, index := range w.watches {
|
|
||||||
indexes = append(indexes, index)
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
for _, index := range indexes {
|
|
||||||
for _, watch := range index {
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
var err error
|
|
||||||
if e := syscall.CloseHandle(w.port); e != nil {
|
|
||||||
err = os.NewSyscallError("CloseHandle", e)
|
|
||||||
}
|
|
||||||
close(w.Events)
|
|
||||||
close(w.Errors)
|
|
||||||
ch <- err
|
|
||||||
return
|
|
||||||
case in := <-w.input:
|
|
||||||
switch in.op {
|
|
||||||
case opAddWatch:
|
|
||||||
in.reply <- w.addWatch(in.path, uint64(in.flags))
|
|
||||||
case opRemoveWatch:
|
|
||||||
in.reply <- w.remWatch(in.path)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
switch e {
|
|
||||||
case syscall.ERROR_MORE_DATA:
|
|
||||||
if watch == nil {
|
|
||||||
w.Errors <- errors.New("ERROR_MORE_DATA has unexpectedly null lpOverlapped buffer")
|
|
||||||
} else {
|
|
||||||
// The i/o succeeded but the buffer is full.
|
|
||||||
// In theory we should be building up a full packet.
|
|
||||||
// In practice we can get away with just carrying on.
|
|
||||||
n = uint32(unsafe.Sizeof(watch.buf))
|
|
||||||
}
|
|
||||||
case syscall.ERROR_ACCESS_DENIED:
|
|
||||||
// Watched directory was probably removed
|
|
||||||
w.sendEvent(watch.path, watch.mask&sysFSDELETESELF)
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
continue
|
|
||||||
case syscall.ERROR_OPERATION_ABORTED:
|
|
||||||
// CancelIo was called on this handle
|
|
||||||
continue
|
|
||||||
default:
|
|
||||||
w.Errors <- os.NewSyscallError("GetQueuedCompletionPort", e)
|
|
||||||
continue
|
|
||||||
case nil:
|
|
||||||
}
|
|
||||||
|
|
||||||
var offset uint32
|
|
||||||
for {
|
|
||||||
if n == 0 {
|
|
||||||
w.Events <- newEvent("", sysFSQOVERFLOW)
|
|
||||||
w.Errors <- errors.New("short read in readEvents()")
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
// Point "raw" to the event in the buffer
|
|
||||||
raw := (*syscall.FileNotifyInformation)(unsafe.Pointer(&watch.buf[offset]))
|
|
||||||
buf := (*[syscall.MAX_PATH]uint16)(unsafe.Pointer(&raw.FileName))
|
|
||||||
name := syscall.UTF16ToString(buf[:raw.FileNameLength/2])
|
|
||||||
fullname := filepath.Join(watch.path, name)
|
|
||||||
|
|
||||||
var mask uint64
|
|
||||||
switch raw.Action {
|
|
||||||
case syscall.FILE_ACTION_REMOVED:
|
|
||||||
mask = sysFSDELETESELF
|
|
||||||
case syscall.FILE_ACTION_MODIFIED:
|
|
||||||
mask = sysFSMODIFY
|
|
||||||
case syscall.FILE_ACTION_RENAMED_OLD_NAME:
|
|
||||||
watch.rename = name
|
|
||||||
case syscall.FILE_ACTION_RENAMED_NEW_NAME:
|
|
||||||
if watch.names[watch.rename] != 0 {
|
|
||||||
watch.names[name] |= watch.names[watch.rename]
|
|
||||||
delete(watch.names, watch.rename)
|
|
||||||
mask = sysFSMOVESELF
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
sendNameEvent := func() {
|
|
||||||
if w.sendEvent(fullname, watch.names[name]&mask) {
|
|
||||||
if watch.names[name]&sysFSONESHOT != 0 {
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if raw.Action != syscall.FILE_ACTION_RENAMED_NEW_NAME {
|
|
||||||
sendNameEvent()
|
|
||||||
}
|
|
||||||
if raw.Action == syscall.FILE_ACTION_REMOVED {
|
|
||||||
w.sendEvent(fullname, watch.names[name]&sysFSIGNORED)
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
if w.sendEvent(fullname, watch.mask&toFSnotifyFlags(raw.Action)) {
|
|
||||||
if watch.mask&sysFSONESHOT != 0 {
|
|
||||||
watch.mask = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if raw.Action == syscall.FILE_ACTION_RENAMED_NEW_NAME {
|
|
||||||
fullname = filepath.Join(watch.path, watch.rename)
|
|
||||||
sendNameEvent()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Move to the next event in the buffer
|
|
||||||
if raw.NextEntryOffset == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
offset += raw.NextEntryOffset
|
|
||||||
|
|
||||||
// Error!
|
|
||||||
if offset >= n {
|
|
||||||
w.Errors <- errors.New("Windows system assumed buffer larger than it is, events have likely been missed.")
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := w.startRead(watch); err != nil {
|
|
||||||
w.Errors <- err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Watcher) sendEvent(name string, mask uint64) bool {
|
|
||||||
if mask == 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
event := newEvent(name, uint32(mask))
|
|
||||||
select {
|
|
||||||
case ch := <-w.quit:
|
|
||||||
w.quit <- ch
|
|
||||||
case w.Events <- event:
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
func toWindowsFlags(mask uint64) uint32 {
|
|
||||||
var m uint32
|
|
||||||
if mask&sysFSACCESS != 0 {
|
|
||||||
m |= syscall.FILE_NOTIFY_CHANGE_LAST_ACCESS
|
|
||||||
}
|
|
||||||
if mask&sysFSMODIFY != 0 {
|
|
||||||
m |= syscall.FILE_NOTIFY_CHANGE_LAST_WRITE
|
|
||||||
}
|
|
||||||
if mask&sysFSATTRIB != 0 {
|
|
||||||
m |= syscall.FILE_NOTIFY_CHANGE_ATTRIBUTES
|
|
||||||
}
|
|
||||||
if mask&(sysFSMOVE|sysFSCREATE|sysFSDELETE) != 0 {
|
|
||||||
m |= syscall.FILE_NOTIFY_CHANGE_FILE_NAME | syscall.FILE_NOTIFY_CHANGE_DIR_NAME
|
|
||||||
}
|
|
||||||
return m
|
|
||||||
}
|
|
||||||
|
|
||||||
func toFSnotifyFlags(action uint32) uint64 {
|
|
||||||
switch action {
|
|
||||||
case syscall.FILE_ACTION_ADDED:
|
|
||||||
return sysFSCREATE
|
|
||||||
case syscall.FILE_ACTION_REMOVED:
|
|
||||||
return sysFSDELETE
|
|
||||||
case syscall.FILE_ACTION_MODIFIED:
|
|
||||||
return sysFSMODIFY
|
|
||||||
case syscall.FILE_ACTION_RENAMED_OLD_NAME:
|
|
||||||
return sysFSMOVEDFROM
|
|
||||||
case syscall.FILE_ACTION_RENAMED_NEW_NAME:
|
|
||||||
return sysFSMOVEDTO
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
16
vendor/github.com/golang/snappy/.gitignore
generated
vendored
16
vendor/github.com/golang/snappy/.gitignore
generated
vendored
|
@ -1,16 +0,0 @@
|
||||||
cmd/snappytool/snappytool
|
|
||||||
testdata/bench
|
|
||||||
|
|
||||||
# These explicitly listed benchmark data files are for an obsolete version of
|
|
||||||
# snappy_test.go.
|
|
||||||
testdata/alice29.txt
|
|
||||||
testdata/asyoulik.txt
|
|
||||||
testdata/fireworks.jpeg
|
|
||||||
testdata/geo.protodata
|
|
||||||
testdata/html
|
|
||||||
testdata/html_x_4
|
|
||||||
testdata/kppkn.gtb
|
|
||||||
testdata/lcet10.txt
|
|
||||||
testdata/paper-100k.pdf
|
|
||||||
testdata/plrabn12.txt
|
|
||||||
testdata/urls.10K
|
|
15
vendor/github.com/golang/snappy/AUTHORS
generated
vendored
15
vendor/github.com/golang/snappy/AUTHORS
generated
vendored
|
@ -1,15 +0,0 @@
|
||||||
# This is the official list of Snappy-Go authors for copyright purposes.
|
|
||||||
# This file is distinct from the CONTRIBUTORS files.
|
|
||||||
# See the latter for an explanation.
|
|
||||||
|
|
||||||
# Names should be added to this file as
|
|
||||||
# Name or Organization <email address>
|
|
||||||
# The email address is not required for organizations.
|
|
||||||
|
|
||||||
# Please keep the list sorted.
|
|
||||||
|
|
||||||
Damian Gryski <dgryski@gmail.com>
|
|
||||||
Google Inc.
|
|
||||||
Jan Mercl <0xjnml@gmail.com>
|
|
||||||
Rodolfo Carvalho <rhcarvalho@gmail.com>
|
|
||||||
Sebastien Binet <seb.binet@gmail.com>
|
|
37
vendor/github.com/golang/snappy/CONTRIBUTORS
generated
vendored
37
vendor/github.com/golang/snappy/CONTRIBUTORS
generated
vendored
|
@ -1,37 +0,0 @@
|
||||||
# This is the official list of people who can contribute
|
|
||||||
# (and typically have contributed) code to the Snappy-Go repository.
|
|
||||||
# The AUTHORS file lists the copyright holders; this file
|
|
||||||
# lists people. For example, Google employees are listed here
|
|
||||||
# but not in AUTHORS, because Google holds the copyright.
|
|
||||||
#
|
|
||||||
# The submission process automatically checks to make sure
|
|
||||||
# that people submitting code are listed in this file (by email address).
|
|
||||||
#
|
|
||||||
# Names should be added to this file only after verifying that
|
|
||||||
# the individual or the individual's organization has agreed to
|
|
||||||
# the appropriate Contributor License Agreement, found here:
|
|
||||||
#
|
|
||||||
# http://code.google.com/legal/individual-cla-v1.0.html
|
|
||||||
# http://code.google.com/legal/corporate-cla-v1.0.html
|
|
||||||
#
|
|
||||||
# The agreement for individuals can be filled out on the web.
|
|
||||||
#
|
|
||||||
# When adding J Random Contributor's name to this file,
|
|
||||||
# either J's name or J's organization's name should be
|
|
||||||
# added to the AUTHORS file, depending on whether the
|
|
||||||
# individual or corporate CLA was used.
|
|
||||||
|
|
||||||
# Names should be added to this file like so:
|
|
||||||
# Name <email address>
|
|
||||||
|
|
||||||
# Please keep the list sorted.
|
|
||||||
|
|
||||||
Damian Gryski <dgryski@gmail.com>
|
|
||||||
Jan Mercl <0xjnml@gmail.com>
|
|
||||||
Kai Backman <kaib@golang.org>
|
|
||||||
Marc-Antoine Ruel <maruel@chromium.org>
|
|
||||||
Nigel Tao <nigeltao@golang.org>
|
|
||||||
Rob Pike <r@golang.org>
|
|
||||||
Rodolfo Carvalho <rhcarvalho@gmail.com>
|
|
||||||
Russ Cox <rsc@golang.org>
|
|
||||||
Sebastien Binet <seb.binet@gmail.com>
|
|
27
vendor/github.com/golang/snappy/LICENSE
generated
vendored
27
vendor/github.com/golang/snappy/LICENSE
generated
vendored
|
@ -1,27 +0,0 @@
|
||||||
Copyright (c) 2011 The Snappy-Go Authors. All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are
|
|
||||||
met:
|
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright
|
|
||||||
notice, this list of conditions and the following disclaimer.
|
|
||||||
* Redistributions in binary form must reproduce the above
|
|
||||||
copyright notice, this list of conditions and the following disclaimer
|
|
||||||
in the documentation and/or other materials provided with the
|
|
||||||
distribution.
|
|
||||||
* Neither the name of Google Inc. nor the names of its
|
|
||||||
contributors may be used to endorse or promote products derived from
|
|
||||||
this software without specific prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
||||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
||||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
||||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
||||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
||||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
107
vendor/github.com/golang/snappy/README
generated
vendored
107
vendor/github.com/golang/snappy/README
generated
vendored
|
@ -1,107 +0,0 @@
|
||||||
The Snappy compression format in the Go programming language.
|
|
||||||
|
|
||||||
To download and install from source:
|
|
||||||
$ go get github.com/golang/snappy
|
|
||||||
|
|
||||||
Unless otherwise noted, the Snappy-Go source files are distributed
|
|
||||||
under the BSD-style license found in the LICENSE file.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Benchmarks.
|
|
||||||
|
|
||||||
The golang/snappy benchmarks include compressing (Z) and decompressing (U) ten
|
|
||||||
or so files, the same set used by the C++ Snappy code (github.com/google/snappy
|
|
||||||
and note the "google", not "golang"). On an "Intel(R) Core(TM) i7-3770 CPU @
|
|
||||||
3.40GHz", Go's GOARCH=amd64 numbers as of 2016-05-29:
|
|
||||||
|
|
||||||
"go test -test.bench=."
|
|
||||||
|
|
||||||
_UFlat0-8 2.19GB/s ± 0% html
|
|
||||||
_UFlat1-8 1.41GB/s ± 0% urls
|
|
||||||
_UFlat2-8 23.5GB/s ± 2% jpg
|
|
||||||
_UFlat3-8 1.91GB/s ± 0% jpg_200
|
|
||||||
_UFlat4-8 14.0GB/s ± 1% pdf
|
|
||||||
_UFlat5-8 1.97GB/s ± 0% html4
|
|
||||||
_UFlat6-8 814MB/s ± 0% txt1
|
|
||||||
_UFlat7-8 785MB/s ± 0% txt2
|
|
||||||
_UFlat8-8 857MB/s ± 0% txt3
|
|
||||||
_UFlat9-8 719MB/s ± 1% txt4
|
|
||||||
_UFlat10-8 2.84GB/s ± 0% pb
|
|
||||||
_UFlat11-8 1.05GB/s ± 0% gaviota
|
|
||||||
|
|
||||||
_ZFlat0-8 1.04GB/s ± 0% html
|
|
||||||
_ZFlat1-8 534MB/s ± 0% urls
|
|
||||||
_ZFlat2-8 15.7GB/s ± 1% jpg
|
|
||||||
_ZFlat3-8 740MB/s ± 3% jpg_200
|
|
||||||
_ZFlat4-8 9.20GB/s ± 1% pdf
|
|
||||||
_ZFlat5-8 991MB/s ± 0% html4
|
|
||||||
_ZFlat6-8 379MB/s ± 0% txt1
|
|
||||||
_ZFlat7-8 352MB/s ± 0% txt2
|
|
||||||
_ZFlat8-8 396MB/s ± 1% txt3
|
|
||||||
_ZFlat9-8 327MB/s ± 1% txt4
|
|
||||||
_ZFlat10-8 1.33GB/s ± 1% pb
|
|
||||||
_ZFlat11-8 605MB/s ± 1% gaviota
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
"go test -test.bench=. -tags=noasm"
|
|
||||||
|
|
||||||
_UFlat0-8 621MB/s ± 2% html
|
|
||||||
_UFlat1-8 494MB/s ± 1% urls
|
|
||||||
_UFlat2-8 23.2GB/s ± 1% jpg
|
|
||||||
_UFlat3-8 1.12GB/s ± 1% jpg_200
|
|
||||||
_UFlat4-8 4.35GB/s ± 1% pdf
|
|
||||||
_UFlat5-8 609MB/s ± 0% html4
|
|
||||||
_UFlat6-8 296MB/s ± 0% txt1
|
|
||||||
_UFlat7-8 288MB/s ± 0% txt2
|
|
||||||
_UFlat8-8 309MB/s ± 1% txt3
|
|
||||||
_UFlat9-8 280MB/s ± 1% txt4
|
|
||||||
_UFlat10-8 753MB/s ± 0% pb
|
|
||||||
_UFlat11-8 400MB/s ± 0% gaviota
|
|
||||||
|
|
||||||
_ZFlat0-8 409MB/s ± 1% html
|
|
||||||
_ZFlat1-8 250MB/s ± 1% urls
|
|
||||||
_ZFlat2-8 12.3GB/s ± 1% jpg
|
|
||||||
_ZFlat3-8 132MB/s ± 0% jpg_200
|
|
||||||
_ZFlat4-8 2.92GB/s ± 0% pdf
|
|
||||||
_ZFlat5-8 405MB/s ± 1% html4
|
|
||||||
_ZFlat6-8 179MB/s ± 1% txt1
|
|
||||||
_ZFlat7-8 170MB/s ± 1% txt2
|
|
||||||
_ZFlat8-8 189MB/s ± 1% txt3
|
|
||||||
_ZFlat9-8 164MB/s ± 1% txt4
|
|
||||||
_ZFlat10-8 479MB/s ± 1% pb
|
|
||||||
_ZFlat11-8 270MB/s ± 1% gaviota
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
For comparison (Go's encoded output is byte-for-byte identical to C++'s), here
|
|
||||||
are the numbers from C++ Snappy's
|
|
||||||
|
|
||||||
make CXXFLAGS="-O2 -DNDEBUG -g" clean snappy_unittest.log && cat snappy_unittest.log
|
|
||||||
|
|
||||||
BM_UFlat/0 2.4GB/s html
|
|
||||||
BM_UFlat/1 1.4GB/s urls
|
|
||||||
BM_UFlat/2 21.8GB/s jpg
|
|
||||||
BM_UFlat/3 1.5GB/s jpg_200
|
|
||||||
BM_UFlat/4 13.3GB/s pdf
|
|
||||||
BM_UFlat/5 2.1GB/s html4
|
|
||||||
BM_UFlat/6 1.0GB/s txt1
|
|
||||||
BM_UFlat/7 959.4MB/s txt2
|
|
||||||
BM_UFlat/8 1.0GB/s txt3
|
|
||||||
BM_UFlat/9 864.5MB/s txt4
|
|
||||||
BM_UFlat/10 2.9GB/s pb
|
|
||||||
BM_UFlat/11 1.2GB/s gaviota
|
|
||||||
|
|
||||||
BM_ZFlat/0 944.3MB/s html (22.31 %)
|
|
||||||
BM_ZFlat/1 501.6MB/s urls (47.78 %)
|
|
||||||
BM_ZFlat/2 14.3GB/s jpg (99.95 %)
|
|
||||||
BM_ZFlat/3 538.3MB/s jpg_200 (73.00 %)
|
|
||||||
BM_ZFlat/4 8.3GB/s pdf (83.30 %)
|
|
||||||
BM_ZFlat/5 903.5MB/s html4 (22.52 %)
|
|
||||||
BM_ZFlat/6 336.0MB/s txt1 (57.88 %)
|
|
||||||
BM_ZFlat/7 312.3MB/s txt2 (61.91 %)
|
|
||||||
BM_ZFlat/8 353.1MB/s txt3 (54.99 %)
|
|
||||||
BM_ZFlat/9 289.9MB/s txt4 (66.26 %)
|
|
||||||
BM_ZFlat/10 1.2GB/s pb (19.68 %)
|
|
||||||
BM_ZFlat/11 527.4MB/s gaviota (37.72 %)
|
|
237
vendor/github.com/golang/snappy/decode.go
generated
vendored
237
vendor/github.com/golang/snappy/decode.go
generated
vendored
|
@ -1,237 +0,0 @@
|
||||||
// Copyright 2011 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrCorrupt reports that the input is invalid.
|
|
||||||
ErrCorrupt = errors.New("snappy: corrupt input")
|
|
||||||
// ErrTooLarge reports that the uncompressed length is too large.
|
|
||||||
ErrTooLarge = errors.New("snappy: decoded block is too large")
|
|
||||||
// ErrUnsupported reports that the input isn't supported.
|
|
||||||
ErrUnsupported = errors.New("snappy: unsupported input")
|
|
||||||
|
|
||||||
errUnsupportedLiteralLength = errors.New("snappy: unsupported literal length")
|
|
||||||
)
|
|
||||||
|
|
||||||
// DecodedLen returns the length of the decoded block.
|
|
||||||
func DecodedLen(src []byte) (int, error) {
|
|
||||||
v, _, err := decodedLen(src)
|
|
||||||
return v, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// decodedLen returns the length of the decoded block and the number of bytes
|
|
||||||
// that the length header occupied.
|
|
||||||
func decodedLen(src []byte) (blockLen, headerLen int, err error) {
|
|
||||||
v, n := binary.Uvarint(src)
|
|
||||||
if n <= 0 || v > 0xffffffff {
|
|
||||||
return 0, 0, ErrCorrupt
|
|
||||||
}
|
|
||||||
|
|
||||||
const wordSize = 32 << (^uint(0) >> 32 & 1)
|
|
||||||
if wordSize == 32 && v > 0x7fffffff {
|
|
||||||
return 0, 0, ErrTooLarge
|
|
||||||
}
|
|
||||||
return int(v), n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
decodeErrCodeCorrupt = 1
|
|
||||||
decodeErrCodeUnsupportedLiteralLength = 2
|
|
||||||
)
|
|
||||||
|
|
||||||
// Decode returns the decoded form of src. The returned slice may be a sub-
|
|
||||||
// slice of dst if dst was large enough to hold the entire decoded block.
|
|
||||||
// Otherwise, a newly allocated slice will be returned.
|
|
||||||
//
|
|
||||||
// The dst and src must not overlap. It is valid to pass a nil dst.
|
|
||||||
func Decode(dst, src []byte) ([]byte, error) {
|
|
||||||
dLen, s, err := decodedLen(src)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if dLen <= len(dst) {
|
|
||||||
dst = dst[:dLen]
|
|
||||||
} else {
|
|
||||||
dst = make([]byte, dLen)
|
|
||||||
}
|
|
||||||
switch decode(dst, src[s:]) {
|
|
||||||
case 0:
|
|
||||||
return dst, nil
|
|
||||||
case decodeErrCodeUnsupportedLiteralLength:
|
|
||||||
return nil, errUnsupportedLiteralLength
|
|
||||||
}
|
|
||||||
return nil, ErrCorrupt
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewReader returns a new Reader that decompresses from r, using the framing
|
|
||||||
// format described at
|
|
||||||
// https://github.com/google/snappy/blob/master/framing_format.txt
|
|
||||||
func NewReader(r io.Reader) *Reader {
|
|
||||||
return &Reader{
|
|
||||||
r: r,
|
|
||||||
decoded: make([]byte, maxBlockSize),
|
|
||||||
buf: make([]byte, maxEncodedLenOfMaxBlockSize+checksumSize),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reader is an io.Reader that can read Snappy-compressed bytes.
|
|
||||||
type Reader struct {
|
|
||||||
r io.Reader
|
|
||||||
err error
|
|
||||||
decoded []byte
|
|
||||||
buf []byte
|
|
||||||
// decoded[i:j] contains decoded bytes that have not yet been passed on.
|
|
||||||
i, j int
|
|
||||||
readHeader bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset discards any buffered data, resets all state, and switches the Snappy
|
|
||||||
// reader to read from r. This permits reusing a Reader rather than allocating
|
|
||||||
// a new one.
|
|
||||||
func (r *Reader) Reset(reader io.Reader) {
|
|
||||||
r.r = reader
|
|
||||||
r.err = nil
|
|
||||||
r.i = 0
|
|
||||||
r.j = 0
|
|
||||||
r.readHeader = false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Reader) readFull(p []byte, allowEOF bool) (ok bool) {
|
|
||||||
if _, r.err = io.ReadFull(r.r, p); r.err != nil {
|
|
||||||
if r.err == io.ErrUnexpectedEOF || (r.err == io.EOF && !allowEOF) {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read satisfies the io.Reader interface.
|
|
||||||
func (r *Reader) Read(p []byte) (int, error) {
|
|
||||||
if r.err != nil {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
for {
|
|
||||||
if r.i < r.j {
|
|
||||||
n := copy(p, r.decoded[r.i:r.j])
|
|
||||||
r.i += n
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
if !r.readFull(r.buf[:4], true) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
chunkType := r.buf[0]
|
|
||||||
if !r.readHeader {
|
|
||||||
if chunkType != chunkTypeStreamIdentifier {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
r.readHeader = true
|
|
||||||
}
|
|
||||||
chunkLen := int(r.buf[1]) | int(r.buf[2])<<8 | int(r.buf[3])<<16
|
|
||||||
if chunkLen > len(r.buf) {
|
|
||||||
r.err = ErrUnsupported
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
|
|
||||||
// The chunk types are specified at
|
|
||||||
// https://github.com/google/snappy/blob/master/framing_format.txt
|
|
||||||
switch chunkType {
|
|
||||||
case chunkTypeCompressedData:
|
|
||||||
// Section 4.2. Compressed data (chunk type 0x00).
|
|
||||||
if chunkLen < checksumSize {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
buf := r.buf[:chunkLen]
|
|
||||||
if !r.readFull(buf, false) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
checksum := uint32(buf[0]) | uint32(buf[1])<<8 | uint32(buf[2])<<16 | uint32(buf[3])<<24
|
|
||||||
buf = buf[checksumSize:]
|
|
||||||
|
|
||||||
n, err := DecodedLen(buf)
|
|
||||||
if err != nil {
|
|
||||||
r.err = err
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if n > len(r.decoded) {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if _, err := Decode(r.decoded, buf); err != nil {
|
|
||||||
r.err = err
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if crc(r.decoded[:n]) != checksum {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
r.i, r.j = 0, n
|
|
||||||
continue
|
|
||||||
|
|
||||||
case chunkTypeUncompressedData:
|
|
||||||
// Section 4.3. Uncompressed data (chunk type 0x01).
|
|
||||||
if chunkLen < checksumSize {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
buf := r.buf[:checksumSize]
|
|
||||||
if !r.readFull(buf, false) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
checksum := uint32(buf[0]) | uint32(buf[1])<<8 | uint32(buf[2])<<16 | uint32(buf[3])<<24
|
|
||||||
// Read directly into r.decoded instead of via r.buf.
|
|
||||||
n := chunkLen - checksumSize
|
|
||||||
if n > len(r.decoded) {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if !r.readFull(r.decoded[:n], false) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if crc(r.decoded[:n]) != checksum {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
r.i, r.j = 0, n
|
|
||||||
continue
|
|
||||||
|
|
||||||
case chunkTypeStreamIdentifier:
|
|
||||||
// Section 4.1. Stream identifier (chunk type 0xff).
|
|
||||||
if chunkLen != len(magicBody) {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
if !r.readFull(r.buf[:len(magicBody)], false) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
for i := 0; i < len(magicBody); i++ {
|
|
||||||
if r.buf[i] != magicBody[i] {
|
|
||||||
r.err = ErrCorrupt
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if chunkType <= 0x7f {
|
|
||||||
// Section 4.5. Reserved unskippable chunks (chunk types 0x02-0x7f).
|
|
||||||
r.err = ErrUnsupported
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
// Section 4.4 Padding (chunk type 0xfe).
|
|
||||||
// Section 4.6. Reserved skippable chunks (chunk types 0x80-0xfd).
|
|
||||||
if !r.readFull(r.buf[:chunkLen], false) {
|
|
||||||
return 0, r.err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
14
vendor/github.com/golang/snappy/decode_amd64.go
generated
vendored
14
vendor/github.com/golang/snappy/decode_amd64.go
generated
vendored
|
@ -1,14 +0,0 @@
|
||||||
// Copyright 2016 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !appengine
|
|
||||||
// +build gc
|
|
||||||
// +build !noasm
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
// decode has the same semantics as in decode_other.go.
|
|
||||||
//
|
|
||||||
//go:noescape
|
|
||||||
func decode(dst, src []byte) int
|
|
490
vendor/github.com/golang/snappy/decode_amd64.s
generated
vendored
490
vendor/github.com/golang/snappy/decode_amd64.s
generated
vendored
|
@ -1,490 +0,0 @@
|
||||||
// Copyright 2016 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !appengine
|
|
||||||
// +build gc
|
|
||||||
// +build !noasm
|
|
||||||
|
|
||||||
#include "textflag.h"
|
|
||||||
|
|
||||||
// The asm code generally follows the pure Go code in decode_other.go, except
|
|
||||||
// where marked with a "!!!".
|
|
||||||
|
|
||||||
// func decode(dst, src []byte) int
|
|
||||||
//
|
|
||||||
// All local variables fit into registers. The non-zero stack size is only to
|
|
||||||
// spill registers and push args when issuing a CALL. The register allocation:
|
|
||||||
// - AX scratch
|
|
||||||
// - BX scratch
|
|
||||||
// - CX length or x
|
|
||||||
// - DX offset
|
|
||||||
// - SI &src[s]
|
|
||||||
// - DI &dst[d]
|
|
||||||
// + R8 dst_base
|
|
||||||
// + R9 dst_len
|
|
||||||
// + R10 dst_base + dst_len
|
|
||||||
// + R11 src_base
|
|
||||||
// + R12 src_len
|
|
||||||
// + R13 src_base + src_len
|
|
||||||
// - R14 used by doCopy
|
|
||||||
// - R15 used by doCopy
|
|
||||||
//
|
|
||||||
// The registers R8-R13 (marked with a "+") are set at the start of the
|
|
||||||
// function, and after a CALL returns, and are not otherwise modified.
|
|
||||||
//
|
|
||||||
// The d variable is implicitly DI - R8, and len(dst)-d is R10 - DI.
|
|
||||||
// The s variable is implicitly SI - R11, and len(src)-s is R13 - SI.
|
|
||||||
TEXT ·decode(SB), NOSPLIT, $48-56
|
|
||||||
// Initialize SI, DI and R8-R13.
|
|
||||||
MOVQ dst_base+0(FP), R8
|
|
||||||
MOVQ dst_len+8(FP), R9
|
|
||||||
MOVQ R8, DI
|
|
||||||
MOVQ R8, R10
|
|
||||||
ADDQ R9, R10
|
|
||||||
MOVQ src_base+24(FP), R11
|
|
||||||
MOVQ src_len+32(FP), R12
|
|
||||||
MOVQ R11, SI
|
|
||||||
MOVQ R11, R13
|
|
||||||
ADDQ R12, R13
|
|
||||||
|
|
||||||
loop:
|
|
||||||
// for s < len(src)
|
|
||||||
CMPQ SI, R13
|
|
||||||
JEQ end
|
|
||||||
|
|
||||||
// CX = uint32(src[s])
|
|
||||||
//
|
|
||||||
// switch src[s] & 0x03
|
|
||||||
MOVBLZX (SI), CX
|
|
||||||
MOVL CX, BX
|
|
||||||
ANDL $3, BX
|
|
||||||
CMPL BX, $1
|
|
||||||
JAE tagCopy
|
|
||||||
|
|
||||||
// ----------------------------------------
|
|
||||||
// The code below handles literal tags.
|
|
||||||
|
|
||||||
// case tagLiteral:
|
|
||||||
// x := uint32(src[s] >> 2)
|
|
||||||
// switch
|
|
||||||
SHRL $2, CX
|
|
||||||
CMPL CX, $60
|
|
||||||
JAE tagLit60Plus
|
|
||||||
|
|
||||||
// case x < 60:
|
|
||||||
// s++
|
|
||||||
INCQ SI
|
|
||||||
|
|
||||||
doLit:
|
|
||||||
// This is the end of the inner "switch", when we have a literal tag.
|
|
||||||
//
|
|
||||||
// We assume that CX == x and x fits in a uint32, where x is the variable
|
|
||||||
// used in the pure Go decode_other.go code.
|
|
||||||
|
|
||||||
// length = int(x) + 1
|
|
||||||
//
|
|
||||||
// Unlike the pure Go code, we don't need to check if length <= 0 because
|
|
||||||
// CX can hold 64 bits, so the increment cannot overflow.
|
|
||||||
INCQ CX
|
|
||||||
|
|
||||||
// Prepare to check if copying length bytes will run past the end of dst or
|
|
||||||
// src.
|
|
||||||
//
|
|
||||||
// AX = len(dst) - d
|
|
||||||
// BX = len(src) - s
|
|
||||||
MOVQ R10, AX
|
|
||||||
SUBQ DI, AX
|
|
||||||
MOVQ R13, BX
|
|
||||||
SUBQ SI, BX
|
|
||||||
|
|
||||||
// !!! Try a faster technique for short (16 or fewer bytes) copies.
|
|
||||||
//
|
|
||||||
// if length > 16 || len(dst)-d < 16 || len(src)-s < 16 {
|
|
||||||
// goto callMemmove // Fall back on calling runtime·memmove.
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// The C++ snappy code calls this TryFastAppend. It also checks len(src)-s
|
|
||||||
// against 21 instead of 16, because it cannot assume that all of its input
|
|
||||||
// is contiguous in memory and so it needs to leave enough source bytes to
|
|
||||||
// read the next tag without refilling buffers, but Go's Decode assumes
|
|
||||||
// contiguousness (the src argument is a []byte).
|
|
||||||
CMPQ CX, $16
|
|
||||||
JGT callMemmove
|
|
||||||
CMPQ AX, $16
|
|
||||||
JLT callMemmove
|
|
||||||
CMPQ BX, $16
|
|
||||||
JLT callMemmove
|
|
||||||
|
|
||||||
// !!! Implement the copy from src to dst as a 16-byte load and store.
|
|
||||||
// (Decode's documentation says that dst and src must not overlap.)
|
|
||||||
//
|
|
||||||
// This always copies 16 bytes, instead of only length bytes, but that's
|
|
||||||
// OK. If the input is a valid Snappy encoding then subsequent iterations
|
|
||||||
// will fix up the overrun. Otherwise, Decode returns a nil []byte (and a
|
|
||||||
// non-nil error), so the overrun will be ignored.
|
|
||||||
//
|
|
||||||
// Note that on amd64, it is legal and cheap to issue unaligned 8-byte or
|
|
||||||
// 16-byte loads and stores. This technique probably wouldn't be as
|
|
||||||
// effective on architectures that are fussier about alignment.
|
|
||||||
MOVOU 0(SI), X0
|
|
||||||
MOVOU X0, 0(DI)
|
|
||||||
|
|
||||||
// d += length
|
|
||||||
// s += length
|
|
||||||
ADDQ CX, DI
|
|
||||||
ADDQ CX, SI
|
|
||||||
JMP loop
|
|
||||||
|
|
||||||
callMemmove:
|
|
||||||
// if length > len(dst)-d || length > len(src)-s { etc }
|
|
||||||
CMPQ CX, AX
|
|
||||||
JGT errCorrupt
|
|
||||||
CMPQ CX, BX
|
|
||||||
JGT errCorrupt
|
|
||||||
|
|
||||||
// copy(dst[d:], src[s:s+length])
|
|
||||||
//
|
|
||||||
// This means calling runtime·memmove(&dst[d], &src[s], length), so we push
|
|
||||||
// DI, SI and CX as arguments. Coincidentally, we also need to spill those
|
|
||||||
// three registers to the stack, to save local variables across the CALL.
|
|
||||||
MOVQ DI, 0(SP)
|
|
||||||
MOVQ SI, 8(SP)
|
|
||||||
MOVQ CX, 16(SP)
|
|
||||||
MOVQ DI, 24(SP)
|
|
||||||
MOVQ SI, 32(SP)
|
|
||||||
MOVQ CX, 40(SP)
|
|
||||||
CALL runtime·memmove(SB)
|
|
||||||
|
|
||||||
// Restore local variables: unspill registers from the stack and
|
|
||||||
// re-calculate R8-R13.
|
|
||||||
MOVQ 24(SP), DI
|
|
||||||
MOVQ 32(SP), SI
|
|
||||||
MOVQ 40(SP), CX
|
|
||||||
MOVQ dst_base+0(FP), R8
|
|
||||||
MOVQ dst_len+8(FP), R9
|
|
||||||
MOVQ R8, R10
|
|
||||||
ADDQ R9, R10
|
|
||||||
MOVQ src_base+24(FP), R11
|
|
||||||
MOVQ src_len+32(FP), R12
|
|
||||||
MOVQ R11, R13
|
|
||||||
ADDQ R12, R13
|
|
||||||
|
|
||||||
// d += length
|
|
||||||
// s += length
|
|
||||||
ADDQ CX, DI
|
|
||||||
ADDQ CX, SI
|
|
||||||
JMP loop
|
|
||||||
|
|
||||||
tagLit60Plus:
|
|
||||||
// !!! This fragment does the
|
|
||||||
//
|
|
||||||
// s += x - 58; if uint(s) > uint(len(src)) { etc }
|
|
||||||
//
|
|
||||||
// checks. In the asm version, we code it once instead of once per switch case.
|
|
||||||
ADDQ CX, SI
|
|
||||||
SUBQ $58, SI
|
|
||||||
MOVQ SI, BX
|
|
||||||
SUBQ R11, BX
|
|
||||||
CMPQ BX, R12
|
|
||||||
JA errCorrupt
|
|
||||||
|
|
||||||
// case x == 60:
|
|
||||||
CMPL CX, $61
|
|
||||||
JEQ tagLit61
|
|
||||||
JA tagLit62Plus
|
|
||||||
|
|
||||||
// x = uint32(src[s-1])
|
|
||||||
MOVBLZX -1(SI), CX
|
|
||||||
JMP doLit
|
|
||||||
|
|
||||||
tagLit61:
|
|
||||||
// case x == 61:
|
|
||||||
// x = uint32(src[s-2]) | uint32(src[s-1])<<8
|
|
||||||
MOVWLZX -2(SI), CX
|
|
||||||
JMP doLit
|
|
||||||
|
|
||||||
tagLit62Plus:
|
|
||||||
CMPL CX, $62
|
|
||||||
JA tagLit63
|
|
||||||
|
|
||||||
// case x == 62:
|
|
||||||
// x = uint32(src[s-3]) | uint32(src[s-2])<<8 | uint32(src[s-1])<<16
|
|
||||||
MOVWLZX -3(SI), CX
|
|
||||||
MOVBLZX -1(SI), BX
|
|
||||||
SHLL $16, BX
|
|
||||||
ORL BX, CX
|
|
||||||
JMP doLit
|
|
||||||
|
|
||||||
tagLit63:
|
|
||||||
// case x == 63:
|
|
||||||
// x = uint32(src[s-4]) | uint32(src[s-3])<<8 | uint32(src[s-2])<<16 | uint32(src[s-1])<<24
|
|
||||||
MOVL -4(SI), CX
|
|
||||||
JMP doLit
|
|
||||||
|
|
||||||
// The code above handles literal tags.
|
|
||||||
// ----------------------------------------
|
|
||||||
// The code below handles copy tags.
|
|
||||||
|
|
||||||
tagCopy4:
|
|
||||||
// case tagCopy4:
|
|
||||||
// s += 5
|
|
||||||
ADDQ $5, SI
|
|
||||||
|
|
||||||
// if uint(s) > uint(len(src)) { etc }
|
|
||||||
MOVQ SI, BX
|
|
||||||
SUBQ R11, BX
|
|
||||||
CMPQ BX, R12
|
|
||||||
JA errCorrupt
|
|
||||||
|
|
||||||
// length = 1 + int(src[s-5])>>2
|
|
||||||
SHRQ $2, CX
|
|
||||||
INCQ CX
|
|
||||||
|
|
||||||
// offset = int(uint32(src[s-4]) | uint32(src[s-3])<<8 | uint32(src[s-2])<<16 | uint32(src[s-1])<<24)
|
|
||||||
MOVLQZX -4(SI), DX
|
|
||||||
JMP doCopy
|
|
||||||
|
|
||||||
tagCopy2:
|
|
||||||
// case tagCopy2:
|
|
||||||
// s += 3
|
|
||||||
ADDQ $3, SI
|
|
||||||
|
|
||||||
// if uint(s) > uint(len(src)) { etc }
|
|
||||||
MOVQ SI, BX
|
|
||||||
SUBQ R11, BX
|
|
||||||
CMPQ BX, R12
|
|
||||||
JA errCorrupt
|
|
||||||
|
|
||||||
// length = 1 + int(src[s-3])>>2
|
|
||||||
SHRQ $2, CX
|
|
||||||
INCQ CX
|
|
||||||
|
|
||||||
// offset = int(uint32(src[s-2]) | uint32(src[s-1])<<8)
|
|
||||||
MOVWQZX -2(SI), DX
|
|
||||||
JMP doCopy
|
|
||||||
|
|
||||||
tagCopy:
|
|
||||||
// We have a copy tag. We assume that:
|
|
||||||
// - BX == src[s] & 0x03
|
|
||||||
// - CX == src[s]
|
|
||||||
CMPQ BX, $2
|
|
||||||
JEQ tagCopy2
|
|
||||||
JA tagCopy4
|
|
||||||
|
|
||||||
// case tagCopy1:
|
|
||||||
// s += 2
|
|
||||||
ADDQ $2, SI
|
|
||||||
|
|
||||||
// if uint(s) > uint(len(src)) { etc }
|
|
||||||
MOVQ SI, BX
|
|
||||||
SUBQ R11, BX
|
|
||||||
CMPQ BX, R12
|
|
||||||
JA errCorrupt
|
|
||||||
|
|
||||||
// offset = int(uint32(src[s-2])&0xe0<<3 | uint32(src[s-1]))
|
|
||||||
MOVQ CX, DX
|
|
||||||
ANDQ $0xe0, DX
|
|
||||||
SHLQ $3, DX
|
|
||||||
MOVBQZX -1(SI), BX
|
|
||||||
ORQ BX, DX
|
|
||||||
|
|
||||||
// length = 4 + int(src[s-2])>>2&0x7
|
|
||||||
SHRQ $2, CX
|
|
||||||
ANDQ $7, CX
|
|
||||||
ADDQ $4, CX
|
|
||||||
|
|
||||||
doCopy:
|
|
||||||
// This is the end of the outer "switch", when we have a copy tag.
|
|
||||||
//
|
|
||||||
// We assume that:
|
|
||||||
// - CX == length && CX > 0
|
|
||||||
// - DX == offset
|
|
||||||
|
|
||||||
// if offset <= 0 { etc }
|
|
||||||
CMPQ DX, $0
|
|
||||||
JLE errCorrupt
|
|
||||||
|
|
||||||
// if d < offset { etc }
|
|
||||||
MOVQ DI, BX
|
|
||||||
SUBQ R8, BX
|
|
||||||
CMPQ BX, DX
|
|
||||||
JLT errCorrupt
|
|
||||||
|
|
||||||
// if length > len(dst)-d { etc }
|
|
||||||
MOVQ R10, BX
|
|
||||||
SUBQ DI, BX
|
|
||||||
CMPQ CX, BX
|
|
||||||
JGT errCorrupt
|
|
||||||
|
|
||||||
// forwardCopy(dst[d:d+length], dst[d-offset:]); d += length
|
|
||||||
//
|
|
||||||
// Set:
|
|
||||||
// - R14 = len(dst)-d
|
|
||||||
// - R15 = &dst[d-offset]
|
|
||||||
MOVQ R10, R14
|
|
||||||
SUBQ DI, R14
|
|
||||||
MOVQ DI, R15
|
|
||||||
SUBQ DX, R15
|
|
||||||
|
|
||||||
// !!! Try a faster technique for short (16 or fewer bytes) forward copies.
|
|
||||||
//
|
|
||||||
// First, try using two 8-byte load/stores, similar to the doLit technique
|
|
||||||
// above. Even if dst[d:d+length] and dst[d-offset:] can overlap, this is
|
|
||||||
// still OK if offset >= 8. Note that this has to be two 8-byte load/stores
|
|
||||||
// and not one 16-byte load/store, and the first store has to be before the
|
|
||||||
// second load, due to the overlap if offset is in the range [8, 16).
|
|
||||||
//
|
|
||||||
// if length > 16 || offset < 8 || len(dst)-d < 16 {
|
|
||||||
// goto slowForwardCopy
|
|
||||||
// }
|
|
||||||
// copy 16 bytes
|
|
||||||
// d += length
|
|
||||||
CMPQ CX, $16
|
|
||||||
JGT slowForwardCopy
|
|
||||||
CMPQ DX, $8
|
|
||||||
JLT slowForwardCopy
|
|
||||||
CMPQ R14, $16
|
|
||||||
JLT slowForwardCopy
|
|
||||||
MOVQ 0(R15), AX
|
|
||||||
MOVQ AX, 0(DI)
|
|
||||||
MOVQ 8(R15), BX
|
|
||||||
MOVQ BX, 8(DI)
|
|
||||||
ADDQ CX, DI
|
|
||||||
JMP loop
|
|
||||||
|
|
||||||
slowForwardCopy:
|
|
||||||
// !!! If the forward copy is longer than 16 bytes, or if offset < 8, we
|
|
||||||
// can still try 8-byte load stores, provided we can overrun up to 10 extra
|
|
||||||
// bytes. As above, the overrun will be fixed up by subsequent iterations
|
|
||||||
// of the outermost loop.
|
|
||||||
//
|
|
||||||
// The C++ snappy code calls this technique IncrementalCopyFastPath. Its
|
|
||||||
// commentary says:
|
|
||||||
//
|
|
||||||
// ----
|
|
||||||
//
|
|
||||||
// The main part of this loop is a simple copy of eight bytes at a time
|
|
||||||
// until we've copied (at least) the requested amount of bytes. However,
|
|
||||||
// if d and d-offset are less than eight bytes apart (indicating a
|
|
||||||
// repeating pattern of length < 8), we first need to expand the pattern in
|
|
||||||
// order to get the correct results. For instance, if the buffer looks like
|
|
||||||
// this, with the eight-byte <d-offset> and <d> patterns marked as
|
|
||||||
// intervals:
|
|
||||||
//
|
|
||||||
// abxxxxxxxxxxxx
|
|
||||||
// [------] d-offset
|
|
||||||
// [------] d
|
|
||||||
//
|
|
||||||
// a single eight-byte copy from <d-offset> to <d> will repeat the pattern
|
|
||||||
// once, after which we can move <d> two bytes without moving <d-offset>:
|
|
||||||
//
|
|
||||||
// ababxxxxxxxxxx
|
|
||||||
// [------] d-offset
|
|
||||||
// [------] d
|
|
||||||
//
|
|
||||||
// and repeat the exercise until the two no longer overlap.
|
|
||||||
//
|
|
||||||
// This allows us to do very well in the special case of one single byte
|
|
||||||
// repeated many times, without taking a big hit for more general cases.
|
|
||||||
//
|
|
||||||
// The worst case of extra writing past the end of the match occurs when
|
|
||||||
// offset == 1 and length == 1; the last copy will read from byte positions
|
|
||||||
// [0..7] and write to [4..11], whereas it was only supposed to write to
|
|
||||||
// position 1. Thus, ten excess bytes.
|
|
||||||
//
|
|
||||||
// ----
|
|
||||||
//
|
|
||||||
// That "10 byte overrun" worst case is confirmed by Go's
|
|
||||||
// TestSlowForwardCopyOverrun, which also tests the fixUpSlowForwardCopy
|
|
||||||
// and finishSlowForwardCopy algorithm.
|
|
||||||
//
|
|
||||||
// if length > len(dst)-d-10 {
|
|
||||||
// goto verySlowForwardCopy
|
|
||||||
// }
|
|
||||||
SUBQ $10, R14
|
|
||||||
CMPQ CX, R14
|
|
||||||
JGT verySlowForwardCopy
|
|
||||||
|
|
||||||
makeOffsetAtLeast8:
|
|
||||||
// !!! As above, expand the pattern so that offset >= 8 and we can use
|
|
||||||
// 8-byte load/stores.
|
|
||||||
//
|
|
||||||
// for offset < 8 {
|
|
||||||
// copy 8 bytes from dst[d-offset:] to dst[d:]
|
|
||||||
// length -= offset
|
|
||||||
// d += offset
|
|
||||||
// offset += offset
|
|
||||||
// // The two previous lines together means that d-offset, and therefore
|
|
||||||
// // R15, is unchanged.
|
|
||||||
// }
|
|
||||||
CMPQ DX, $8
|
|
||||||
JGE fixUpSlowForwardCopy
|
|
||||||
MOVQ (R15), BX
|
|
||||||
MOVQ BX, (DI)
|
|
||||||
SUBQ DX, CX
|
|
||||||
ADDQ DX, DI
|
|
||||||
ADDQ DX, DX
|
|
||||||
JMP makeOffsetAtLeast8
|
|
||||||
|
|
||||||
fixUpSlowForwardCopy:
|
|
||||||
// !!! Add length (which might be negative now) to d (implied by DI being
|
|
||||||
// &dst[d]) so that d ends up at the right place when we jump back to the
|
|
||||||
// top of the loop. Before we do that, though, we save DI to AX so that, if
|
|
||||||
// length is positive, copying the remaining length bytes will write to the
|
|
||||||
// right place.
|
|
||||||
MOVQ DI, AX
|
|
||||||
ADDQ CX, DI
|
|
||||||
|
|
||||||
finishSlowForwardCopy:
|
|
||||||
// !!! Repeat 8-byte load/stores until length <= 0. Ending with a negative
|
|
||||||
// length means that we overrun, but as above, that will be fixed up by
|
|
||||||
// subsequent iterations of the outermost loop.
|
|
||||||
CMPQ CX, $0
|
|
||||||
JLE loop
|
|
||||||
MOVQ (R15), BX
|
|
||||||
MOVQ BX, (AX)
|
|
||||||
ADDQ $8, R15
|
|
||||||
ADDQ $8, AX
|
|
||||||
SUBQ $8, CX
|
|
||||||
JMP finishSlowForwardCopy
|
|
||||||
|
|
||||||
verySlowForwardCopy:
|
|
||||||
// verySlowForwardCopy is a simple implementation of forward copy. In C
|
|
||||||
// parlance, this is a do/while loop instead of a while loop, since we know
|
|
||||||
// that length > 0. In Go syntax:
|
|
||||||
//
|
|
||||||
// for {
|
|
||||||
// dst[d] = dst[d - offset]
|
|
||||||
// d++
|
|
||||||
// length--
|
|
||||||
// if length == 0 {
|
|
||||||
// break
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
MOVB (R15), BX
|
|
||||||
MOVB BX, (DI)
|
|
||||||
INCQ R15
|
|
||||||
INCQ DI
|
|
||||||
DECQ CX
|
|
||||||
JNZ verySlowForwardCopy
|
|
||||||
JMP loop
|
|
||||||
|
|
||||||
// The code above handles copy tags.
|
|
||||||
// ----------------------------------------
|
|
||||||
|
|
||||||
end:
|
|
||||||
// This is the end of the "for s < len(src)".
|
|
||||||
//
|
|
||||||
// if d != len(dst) { etc }
|
|
||||||
CMPQ DI, R10
|
|
||||||
JNE errCorrupt
|
|
||||||
|
|
||||||
// return 0
|
|
||||||
MOVQ $0, ret+48(FP)
|
|
||||||
RET
|
|
||||||
|
|
||||||
errCorrupt:
|
|
||||||
// return decodeErrCodeCorrupt
|
|
||||||
MOVQ $1, ret+48(FP)
|
|
||||||
RET
|
|
101
vendor/github.com/golang/snappy/decode_other.go
generated
vendored
101
vendor/github.com/golang/snappy/decode_other.go
generated
vendored
|
@ -1,101 +0,0 @@
|
||||||
// Copyright 2016 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !amd64 appengine !gc noasm
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
// decode writes the decoding of src to dst. It assumes that the varint-encoded
|
|
||||||
// length of the decompressed bytes has already been read, and that len(dst)
|
|
||||||
// equals that length.
|
|
||||||
//
|
|
||||||
// It returns 0 on success or a decodeErrCodeXxx error code on failure.
|
|
||||||
func decode(dst, src []byte) int {
|
|
||||||
var d, s, offset, length int
|
|
||||||
for s < len(src) {
|
|
||||||
switch src[s] & 0x03 {
|
|
||||||
case tagLiteral:
|
|
||||||
x := uint32(src[s] >> 2)
|
|
||||||
switch {
|
|
||||||
case x < 60:
|
|
||||||
s++
|
|
||||||
case x == 60:
|
|
||||||
s += 2
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
x = uint32(src[s-1])
|
|
||||||
case x == 61:
|
|
||||||
s += 3
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
x = uint32(src[s-2]) | uint32(src[s-1])<<8
|
|
||||||
case x == 62:
|
|
||||||
s += 4
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
x = uint32(src[s-3]) | uint32(src[s-2])<<8 | uint32(src[s-1])<<16
|
|
||||||
case x == 63:
|
|
||||||
s += 5
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
x = uint32(src[s-4]) | uint32(src[s-3])<<8 | uint32(src[s-2])<<16 | uint32(src[s-1])<<24
|
|
||||||
}
|
|
||||||
length = int(x) + 1
|
|
||||||
if length <= 0 {
|
|
||||||
return decodeErrCodeUnsupportedLiteralLength
|
|
||||||
}
|
|
||||||
if length > len(dst)-d || length > len(src)-s {
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
copy(dst[d:], src[s:s+length])
|
|
||||||
d += length
|
|
||||||
s += length
|
|
||||||
continue
|
|
||||||
|
|
||||||
case tagCopy1:
|
|
||||||
s += 2
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
length = 4 + int(src[s-2])>>2&0x7
|
|
||||||
offset = int(uint32(src[s-2])&0xe0<<3 | uint32(src[s-1]))
|
|
||||||
|
|
||||||
case tagCopy2:
|
|
||||||
s += 3
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
length = 1 + int(src[s-3])>>2
|
|
||||||
offset = int(uint32(src[s-2]) | uint32(src[s-1])<<8)
|
|
||||||
|
|
||||||
case tagCopy4:
|
|
||||||
s += 5
|
|
||||||
if uint(s) > uint(len(src)) { // The uint conversions catch overflow from the previous line.
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
length = 1 + int(src[s-5])>>2
|
|
||||||
offset = int(uint32(src[s-4]) | uint32(src[s-3])<<8 | uint32(src[s-2])<<16 | uint32(src[s-1])<<24)
|
|
||||||
}
|
|
||||||
|
|
||||||
if offset <= 0 || d < offset || length > len(dst)-d {
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
// Copy from an earlier sub-slice of dst to a later sub-slice. Unlike
|
|
||||||
// the built-in copy function, this byte-by-byte copy always runs
|
|
||||||
// forwards, even if the slices overlap. Conceptually, this is:
|
|
||||||
//
|
|
||||||
// d += forwardCopy(dst[d:d+length], dst[d-offset:])
|
|
||||||
for end := d + length; d != end; d++ {
|
|
||||||
dst[d] = dst[d-offset]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if d != len(dst) {
|
|
||||||
return decodeErrCodeCorrupt
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
285
vendor/github.com/golang/snappy/encode.go
generated
vendored
285
vendor/github.com/golang/snappy/encode.go
generated
vendored
|
@ -1,285 +0,0 @@
|
||||||
// Copyright 2011 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Encode returns the encoded form of src. The returned slice may be a sub-
|
|
||||||
// slice of dst if dst was large enough to hold the entire encoded block.
|
|
||||||
// Otherwise, a newly allocated slice will be returned.
|
|
||||||
//
|
|
||||||
// The dst and src must not overlap. It is valid to pass a nil dst.
|
|
||||||
func Encode(dst, src []byte) []byte {
|
|
||||||
if n := MaxEncodedLen(len(src)); n < 0 {
|
|
||||||
panic(ErrTooLarge)
|
|
||||||
} else if len(dst) < n {
|
|
||||||
dst = make([]byte, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The block starts with the varint-encoded length of the decompressed bytes.
|
|
||||||
d := binary.PutUvarint(dst, uint64(len(src)))
|
|
||||||
|
|
||||||
for len(src) > 0 {
|
|
||||||
p := src
|
|
||||||
src = nil
|
|
||||||
if len(p) > maxBlockSize {
|
|
||||||
p, src = p[:maxBlockSize], p[maxBlockSize:]
|
|
||||||
}
|
|
||||||
if len(p) < minNonLiteralBlockSize {
|
|
||||||
d += emitLiteral(dst[d:], p)
|
|
||||||
} else {
|
|
||||||
d += encodeBlock(dst[d:], p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return dst[:d]
|
|
||||||
}
|
|
||||||
|
|
||||||
// inputMargin is the minimum number of extra input bytes to keep, inside
|
|
||||||
// encodeBlock's inner loop. On some architectures, this margin lets us
|
|
||||||
// implement a fast path for emitLiteral, where the copy of short (<= 16 byte)
|
|
||||||
// literals can be implemented as a single load to and store from a 16-byte
|
|
||||||
// register. That literal's actual length can be as short as 1 byte, so this
|
|
||||||
// can copy up to 15 bytes too much, but that's OK as subsequent iterations of
|
|
||||||
// the encoding loop will fix up the copy overrun, and this inputMargin ensures
|
|
||||||
// that we don't overrun the dst and src buffers.
|
|
||||||
const inputMargin = 16 - 1
|
|
||||||
|
|
||||||
// minNonLiteralBlockSize is the minimum size of the input to encodeBlock that
|
|
||||||
// could be encoded with a copy tag. This is the minimum with respect to the
|
|
||||||
// algorithm used by encodeBlock, not a minimum enforced by the file format.
|
|
||||||
//
|
|
||||||
// The encoded output must start with at least a 1 byte literal, as there are
|
|
||||||
// no previous bytes to copy. A minimal (1 byte) copy after that, generated
|
|
||||||
// from an emitCopy call in encodeBlock's main loop, would require at least
|
|
||||||
// another inputMargin bytes, for the reason above: we want any emitLiteral
|
|
||||||
// calls inside encodeBlock's main loop to use the fast path if possible, which
|
|
||||||
// requires being able to overrun by inputMargin bytes. Thus,
|
|
||||||
// minNonLiteralBlockSize equals 1 + 1 + inputMargin.
|
|
||||||
//
|
|
||||||
// The C++ code doesn't use this exact threshold, but it could, as discussed at
|
|
||||||
// https://groups.google.com/d/topic/snappy-compression/oGbhsdIJSJ8/discussion
|
|
||||||
// The difference between Go (2+inputMargin) and C++ (inputMargin) is purely an
|
|
||||||
// optimization. It should not affect the encoded form. This is tested by
|
|
||||||
// TestSameEncodingAsCppShortCopies.
|
|
||||||
const minNonLiteralBlockSize = 1 + 1 + inputMargin
|
|
||||||
|
|
||||||
// MaxEncodedLen returns the maximum length of a snappy block, given its
|
|
||||||
// uncompressed length.
|
|
||||||
//
|
|
||||||
// It will return a negative value if srcLen is too large to encode.
|
|
||||||
func MaxEncodedLen(srcLen int) int {
|
|
||||||
n := uint64(srcLen)
|
|
||||||
if n > 0xffffffff {
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
// Compressed data can be defined as:
|
|
||||||
// compressed := item* literal*
|
|
||||||
// item := literal* copy
|
|
||||||
//
|
|
||||||
// The trailing literal sequence has a space blowup of at most 62/60
|
|
||||||
// since a literal of length 60 needs one tag byte + one extra byte
|
|
||||||
// for length information.
|
|
||||||
//
|
|
||||||
// Item blowup is trickier to measure. Suppose the "copy" op copies
|
|
||||||
// 4 bytes of data. Because of a special check in the encoding code,
|
|
||||||
// we produce a 4-byte copy only if the offset is < 65536. Therefore
|
|
||||||
// the copy op takes 3 bytes to encode, and this type of item leads
|
|
||||||
// to at most the 62/60 blowup for representing literals.
|
|
||||||
//
|
|
||||||
// Suppose the "copy" op copies 5 bytes of data. If the offset is big
|
|
||||||
// enough, it will take 5 bytes to encode the copy op. Therefore the
|
|
||||||
// worst case here is a one-byte literal followed by a five-byte copy.
|
|
||||||
// That is, 6 bytes of input turn into 7 bytes of "compressed" data.
|
|
||||||
//
|
|
||||||
// This last factor dominates the blowup, so the final estimate is:
|
|
||||||
n = 32 + n + n/6
|
|
||||||
if n > 0xffffffff {
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
return int(n)
|
|
||||||
}
|
|
||||||
|
|
||||||
var errClosed = errors.New("snappy: Writer is closed")
|
|
||||||
|
|
||||||
// NewWriter returns a new Writer that compresses to w.
|
|
||||||
//
|
|
||||||
// The Writer returned does not buffer writes. There is no need to Flush or
|
|
||||||
// Close such a Writer.
|
|
||||||
//
|
|
||||||
// Deprecated: the Writer returned is not suitable for many small writes, only
|
|
||||||
// for few large writes. Use NewBufferedWriter instead, which is efficient
|
|
||||||
// regardless of the frequency and shape of the writes, and remember to Close
|
|
||||||
// that Writer when done.
|
|
||||||
func NewWriter(w io.Writer) *Writer {
|
|
||||||
return &Writer{
|
|
||||||
w: w,
|
|
||||||
obuf: make([]byte, obufLen),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewBufferedWriter returns a new Writer that compresses to w, using the
|
|
||||||
// framing format described at
|
|
||||||
// https://github.com/google/snappy/blob/master/framing_format.txt
|
|
||||||
//
|
|
||||||
// The Writer returned buffers writes. Users must call Close to guarantee all
|
|
||||||
// data has been forwarded to the underlying io.Writer. They may also call
|
|
||||||
// Flush zero or more times before calling Close.
|
|
||||||
func NewBufferedWriter(w io.Writer) *Writer {
|
|
||||||
return &Writer{
|
|
||||||
w: w,
|
|
||||||
ibuf: make([]byte, 0, maxBlockSize),
|
|
||||||
obuf: make([]byte, obufLen),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Writer is an io.Writer that can write Snappy-compressed bytes.
|
|
||||||
type Writer struct {
|
|
||||||
w io.Writer
|
|
||||||
err error
|
|
||||||
|
|
||||||
// ibuf is a buffer for the incoming (uncompressed) bytes.
|
|
||||||
//
|
|
||||||
// Its use is optional. For backwards compatibility, Writers created by the
|
|
||||||
// NewWriter function have ibuf == nil, do not buffer incoming bytes, and
|
|
||||||
// therefore do not need to be Flush'ed or Close'd.
|
|
||||||
ibuf []byte
|
|
||||||
|
|
||||||
// obuf is a buffer for the outgoing (compressed) bytes.
|
|
||||||
obuf []byte
|
|
||||||
|
|
||||||
// wroteStreamHeader is whether we have written the stream header.
|
|
||||||
wroteStreamHeader bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset discards the writer's state and switches the Snappy writer to write to
|
|
||||||
// w. This permits reusing a Writer rather than allocating a new one.
|
|
||||||
func (w *Writer) Reset(writer io.Writer) {
|
|
||||||
w.w = writer
|
|
||||||
w.err = nil
|
|
||||||
if w.ibuf != nil {
|
|
||||||
w.ibuf = w.ibuf[:0]
|
|
||||||
}
|
|
||||||
w.wroteStreamHeader = false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Write satisfies the io.Writer interface.
|
|
||||||
func (w *Writer) Write(p []byte) (nRet int, errRet error) {
|
|
||||||
if w.ibuf == nil {
|
|
||||||
// Do not buffer incoming bytes. This does not perform or compress well
|
|
||||||
// if the caller of Writer.Write writes many small slices. This
|
|
||||||
// behavior is therefore deprecated, but still supported for backwards
|
|
||||||
// compatibility with code that doesn't explicitly Flush or Close.
|
|
||||||
return w.write(p)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The remainder of this method is based on bufio.Writer.Write from the
|
|
||||||
// standard library.
|
|
||||||
|
|
||||||
for len(p) > (cap(w.ibuf)-len(w.ibuf)) && w.err == nil {
|
|
||||||
var n int
|
|
||||||
if len(w.ibuf) == 0 {
|
|
||||||
// Large write, empty buffer.
|
|
||||||
// Write directly from p to avoid copy.
|
|
||||||
n, _ = w.write(p)
|
|
||||||
} else {
|
|
||||||
n = copy(w.ibuf[len(w.ibuf):cap(w.ibuf)], p)
|
|
||||||
w.ibuf = w.ibuf[:len(w.ibuf)+n]
|
|
||||||
w.Flush()
|
|
||||||
}
|
|
||||||
nRet += n
|
|
||||||
p = p[n:]
|
|
||||||
}
|
|
||||||
if w.err != nil {
|
|
||||||
return nRet, w.err
|
|
||||||
}
|
|
||||||
n := copy(w.ibuf[len(w.ibuf):cap(w.ibuf)], p)
|
|
||||||
w.ibuf = w.ibuf[:len(w.ibuf)+n]
|
|
||||||
nRet += n
|
|
||||||
return nRet, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Writer) write(p []byte) (nRet int, errRet error) {
|
|
||||||
if w.err != nil {
|
|
||||||
return 0, w.err
|
|
||||||
}
|
|
||||||
for len(p) > 0 {
|
|
||||||
obufStart := len(magicChunk)
|
|
||||||
if !w.wroteStreamHeader {
|
|
||||||
w.wroteStreamHeader = true
|
|
||||||
copy(w.obuf, magicChunk)
|
|
||||||
obufStart = 0
|
|
||||||
}
|
|
||||||
|
|
||||||
var uncompressed []byte
|
|
||||||
if len(p) > maxBlockSize {
|
|
||||||
uncompressed, p = p[:maxBlockSize], p[maxBlockSize:]
|
|
||||||
} else {
|
|
||||||
uncompressed, p = p, nil
|
|
||||||
}
|
|
||||||
checksum := crc(uncompressed)
|
|
||||||
|
|
||||||
// Compress the buffer, discarding the result if the improvement
|
|
||||||
// isn't at least 12.5%.
|
|
||||||
compressed := Encode(w.obuf[obufHeaderLen:], uncompressed)
|
|
||||||
chunkType := uint8(chunkTypeCompressedData)
|
|
||||||
chunkLen := 4 + len(compressed)
|
|
||||||
obufEnd := obufHeaderLen + len(compressed)
|
|
||||||
if len(compressed) >= len(uncompressed)-len(uncompressed)/8 {
|
|
||||||
chunkType = chunkTypeUncompressedData
|
|
||||||
chunkLen = 4 + len(uncompressed)
|
|
||||||
obufEnd = obufHeaderLen
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fill in the per-chunk header that comes before the body.
|
|
||||||
w.obuf[len(magicChunk)+0] = chunkType
|
|
||||||
w.obuf[len(magicChunk)+1] = uint8(chunkLen >> 0)
|
|
||||||
w.obuf[len(magicChunk)+2] = uint8(chunkLen >> 8)
|
|
||||||
w.obuf[len(magicChunk)+3] = uint8(chunkLen >> 16)
|
|
||||||
w.obuf[len(magicChunk)+4] = uint8(checksum >> 0)
|
|
||||||
w.obuf[len(magicChunk)+5] = uint8(checksum >> 8)
|
|
||||||
w.obuf[len(magicChunk)+6] = uint8(checksum >> 16)
|
|
||||||
w.obuf[len(magicChunk)+7] = uint8(checksum >> 24)
|
|
||||||
|
|
||||||
if _, err := w.w.Write(w.obuf[obufStart:obufEnd]); err != nil {
|
|
||||||
w.err = err
|
|
||||||
return nRet, err
|
|
||||||
}
|
|
||||||
if chunkType == chunkTypeUncompressedData {
|
|
||||||
if _, err := w.w.Write(uncompressed); err != nil {
|
|
||||||
w.err = err
|
|
||||||
return nRet, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
nRet += len(uncompressed)
|
|
||||||
}
|
|
||||||
return nRet, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Flush flushes the Writer to its underlying io.Writer.
|
|
||||||
func (w *Writer) Flush() error {
|
|
||||||
if w.err != nil {
|
|
||||||
return w.err
|
|
||||||
}
|
|
||||||
if len(w.ibuf) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
w.write(w.ibuf)
|
|
||||||
w.ibuf = w.ibuf[:0]
|
|
||||||
return w.err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close calls Flush and then closes the Writer.
|
|
||||||
func (w *Writer) Close() error {
|
|
||||||
w.Flush()
|
|
||||||
ret := w.err
|
|
||||||
if w.err == nil {
|
|
||||||
w.err = errClosed
|
|
||||||
}
|
|
||||||
return ret
|
|
||||||
}
|
|
29
vendor/github.com/golang/snappy/encode_amd64.go
generated
vendored
29
vendor/github.com/golang/snappy/encode_amd64.go
generated
vendored
|
@ -1,29 +0,0 @@
|
||||||
// Copyright 2016 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !appengine
|
|
||||||
// +build gc
|
|
||||||
// +build !noasm
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
// emitLiteral has the same semantics as in encode_other.go.
|
|
||||||
//
|
|
||||||
//go:noescape
|
|
||||||
func emitLiteral(dst, lit []byte) int
|
|
||||||
|
|
||||||
// emitCopy has the same semantics as in encode_other.go.
|
|
||||||
//
|
|
||||||
//go:noescape
|
|
||||||
func emitCopy(dst []byte, offset, length int) int
|
|
||||||
|
|
||||||
// extendMatch has the same semantics as in encode_other.go.
|
|
||||||
//
|
|
||||||
//go:noescape
|
|
||||||
func extendMatch(src []byte, i, j int) int
|
|
||||||
|
|
||||||
// encodeBlock has the same semantics as in encode_other.go.
|
|
||||||
//
|
|
||||||
//go:noescape
|
|
||||||
func encodeBlock(dst, src []byte) (d int)
|
|
730
vendor/github.com/golang/snappy/encode_amd64.s
generated
vendored
730
vendor/github.com/golang/snappy/encode_amd64.s
generated
vendored
|
@ -1,730 +0,0 @@
|
||||||
// Copyright 2016 The Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !appengine
|
|
||||||
// +build gc
|
|
||||||
// +build !noasm
|
|
||||||
|
|
||||||
#include "textflag.h"
|
|
||||||
|
|
||||||
// The XXX lines assemble on Go 1.4, 1.5 and 1.7, but not 1.6, due to a
|
|
||||||
// Go toolchain regression. See https://github.com/golang/go/issues/15426 and
|
|
||||||
// https://github.com/golang/snappy/issues/29
|
|
||||||
//
|
|
||||||
// As a workaround, the package was built with a known good assembler, and
|
|
||||||
// those instructions were disassembled by "objdump -d" to yield the
|
|
||||||
// 4e 0f b7 7c 5c 78 movzwq 0x78(%rsp,%r11,2),%r15
|
|
||||||
// style comments, in AT&T asm syntax. Note that rsp here is a physical
|
|
||||||
// register, not Go/asm's SP pseudo-register (see https://golang.org/doc/asm).
|
|
||||||
// The instructions were then encoded as "BYTE $0x.." sequences, which assemble
|
|
||||||
// fine on Go 1.6.
|
|
||||||
|
|
||||||
// The asm code generally follows the pure Go code in encode_other.go, except
|
|
||||||
// where marked with a "!!!".
|
|
||||||
|
|
||||||
// ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
// func emitLiteral(dst, lit []byte) int
|
|
||||||
//
|
|
||||||
// All local variables fit into registers. The register allocation:
|
|
||||||
// - AX len(lit)
|
|
||||||
// - BX n
|
|
||||||
// - DX return value
|
|
||||||
// - DI &dst[i]
|
|
||||||
// - R10 &lit[0]
|
|
||||||
//
|
|
||||||
// The 24 bytes of stack space is to call runtime·memmove.
|
|
||||||
//
|
|
||||||
// The unusual register allocation of local variables, such as R10 for the
|
|
||||||
// source pointer, matches the allocation used at the call site in encodeBlock,
|
|
||||||
// which makes it easier to manually inline this function.
|
|
||||||
TEXT ·emitLiteral(SB), NOSPLIT, $24-56
|
|
||||||
MOVQ dst_base+0(FP), DI
|
|
||||||
MOVQ lit_base+24(FP), R10
|
|
||||||
MOVQ lit_len+32(FP), AX
|
|
||||||
MOVQ AX, DX
|
|
||||||
MOVL AX, BX
|
|
||||||
SUBL $1, BX
|
|
||||||
|
|
||||||
CMPL BX, $60
|
|
||||||
JLT oneByte
|
|
||||||
CMPL BX, $256
|
|
||||||
JLT twoBytes
|
|
||||||
|
|
||||||
threeBytes:
|
|
||||||
MOVB $0xf4, 0(DI)
|
|
||||||
MOVW BX, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
ADDQ $3, DX
|
|
||||||
JMP memmove
|
|
||||||
|
|
||||||
twoBytes:
|
|
||||||
MOVB $0xf0, 0(DI)
|
|
||||||
MOVB BX, 1(DI)
|
|
||||||
ADDQ $2, DI
|
|
||||||
ADDQ $2, DX
|
|
||||||
JMP memmove
|
|
||||||
|
|
||||||
oneByte:
|
|
||||||
SHLB $2, BX
|
|
||||||
MOVB BX, 0(DI)
|
|
||||||
ADDQ $1, DI
|
|
||||||
ADDQ $1, DX
|
|
||||||
|
|
||||||
memmove:
|
|
||||||
MOVQ DX, ret+48(FP)
|
|
||||||
|
|
||||||
// copy(dst[i:], lit)
|
|
||||||
//
|
|
||||||
// This means calling runtime·memmove(&dst[i], &lit[0], len(lit)), so we push
|
|
||||||
// DI, R10 and AX as arguments.
|
|
||||||
MOVQ DI, 0(SP)
|
|
||||||
MOVQ R10, 8(SP)
|
|
||||||
MOVQ AX, 16(SP)
|
|
||||||
CALL runtime·memmove(SB)
|
|
||||||
RET
|
|
||||||
|
|
||||||
// ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
// func emitCopy(dst []byte, offset, length int) int
|
|
||||||
//
|
|
||||||
// All local variables fit into registers. The register allocation:
|
|
||||||
// - AX length
|
|
||||||
// - SI &dst[0]
|
|
||||||
// - DI &dst[i]
|
|
||||||
// - R11 offset
|
|
||||||
//
|
|
||||||
// The unusual register allocation of local variables, such as R11 for the
|
|
||||||
// offset, matches the allocation used at the call site in encodeBlock, which
|
|
||||||
// makes it easier to manually inline this function.
|
|
||||||
TEXT ·emitCopy(SB), NOSPLIT, $0-48
|
|
||||||
MOVQ dst_base+0(FP), DI
|
|
||||||
MOVQ DI, SI
|
|
||||||
MOVQ offset+24(FP), R11
|
|
||||||
MOVQ length+32(FP), AX
|
|
||||||
|
|
||||||
loop0:
|
|
||||||
// for length >= 68 { etc }
|
|
||||||
CMPL AX, $68
|
|
||||||
JLT step1
|
|
||||||
|
|
||||||
// Emit a length 64 copy, encoded as 3 bytes.
|
|
||||||
MOVB $0xfe, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
SUBL $64, AX
|
|
||||||
JMP loop0
|
|
||||||
|
|
||||||
step1:
|
|
||||||
// if length > 64 { etc }
|
|
||||||
CMPL AX, $64
|
|
||||||
JLE step2
|
|
||||||
|
|
||||||
// Emit a length 60 copy, encoded as 3 bytes.
|
|
||||||
MOVB $0xee, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
SUBL $60, AX
|
|
||||||
|
|
||||||
step2:
|
|
||||||
// if length >= 12 || offset >= 2048 { goto step3 }
|
|
||||||
CMPL AX, $12
|
|
||||||
JGE step3
|
|
||||||
CMPL R11, $2048
|
|
||||||
JGE step3
|
|
||||||
|
|
||||||
// Emit the remaining copy, encoded as 2 bytes.
|
|
||||||
MOVB R11, 1(DI)
|
|
||||||
SHRL $8, R11
|
|
||||||
SHLB $5, R11
|
|
||||||
SUBB $4, AX
|
|
||||||
SHLB $2, AX
|
|
||||||
ORB AX, R11
|
|
||||||
ORB $1, R11
|
|
||||||
MOVB R11, 0(DI)
|
|
||||||
ADDQ $2, DI
|
|
||||||
|
|
||||||
// Return the number of bytes written.
|
|
||||||
SUBQ SI, DI
|
|
||||||
MOVQ DI, ret+40(FP)
|
|
||||||
RET
|
|
||||||
|
|
||||||
step3:
|
|
||||||
// Emit the remaining copy, encoded as 3 bytes.
|
|
||||||
SUBL $1, AX
|
|
||||||
SHLB $2, AX
|
|
||||||
ORB $2, AX
|
|
||||||
MOVB AX, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
|
|
||||||
// Return the number of bytes written.
|
|
||||||
SUBQ SI, DI
|
|
||||||
MOVQ DI, ret+40(FP)
|
|
||||||
RET
|
|
||||||
|
|
||||||
// ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
// func extendMatch(src []byte, i, j int) int
|
|
||||||
//
|
|
||||||
// All local variables fit into registers. The register allocation:
|
|
||||||
// - DX &src[0]
|
|
||||||
// - SI &src[j]
|
|
||||||
// - R13 &src[len(src) - 8]
|
|
||||||
// - R14 &src[len(src)]
|
|
||||||
// - R15 &src[i]
|
|
||||||
//
|
|
||||||
// The unusual register allocation of local variables, such as R15 for a source
|
|
||||||
// pointer, matches the allocation used at the call site in encodeBlock, which
|
|
||||||
// makes it easier to manually inline this function.
|
|
||||||
TEXT ·extendMatch(SB), NOSPLIT, $0-48
|
|
||||||
MOVQ src_base+0(FP), DX
|
|
||||||
MOVQ src_len+8(FP), R14
|
|
||||||
MOVQ i+24(FP), R15
|
|
||||||
MOVQ j+32(FP), SI
|
|
||||||
ADDQ DX, R14
|
|
||||||
ADDQ DX, R15
|
|
||||||
ADDQ DX, SI
|
|
||||||
MOVQ R14, R13
|
|
||||||
SUBQ $8, R13
|
|
||||||
|
|
||||||
cmp8:
|
|
||||||
// As long as we are 8 or more bytes before the end of src, we can load and
|
|
||||||
// compare 8 bytes at a time. If those 8 bytes are equal, repeat.
|
|
||||||
CMPQ SI, R13
|
|
||||||
JA cmp1
|
|
||||||
MOVQ (R15), AX
|
|
||||||
MOVQ (SI), BX
|
|
||||||
CMPQ AX, BX
|
|
||||||
JNE bsf
|
|
||||||
ADDQ $8, R15
|
|
||||||
ADDQ $8, SI
|
|
||||||
JMP cmp8
|
|
||||||
|
|
||||||
bsf:
|
|
||||||
// If those 8 bytes were not equal, XOR the two 8 byte values, and return
|
|
||||||
// the index of the first byte that differs. The BSF instruction finds the
|
|
||||||
// least significant 1 bit, the amd64 architecture is little-endian, and
|
|
||||||
// the shift by 3 converts a bit index to a byte index.
|
|
||||||
XORQ AX, BX
|
|
||||||
BSFQ BX, BX
|
|
||||||
SHRQ $3, BX
|
|
||||||
ADDQ BX, SI
|
|
||||||
|
|
||||||
// Convert from &src[ret] to ret.
|
|
||||||
SUBQ DX, SI
|
|
||||||
MOVQ SI, ret+40(FP)
|
|
||||||
RET
|
|
||||||
|
|
||||||
cmp1:
|
|
||||||
// In src's tail, compare 1 byte at a time.
|
|
||||||
CMPQ SI, R14
|
|
||||||
JAE extendMatchEnd
|
|
||||||
MOVB (R15), AX
|
|
||||||
MOVB (SI), BX
|
|
||||||
CMPB AX, BX
|
|
||||||
JNE extendMatchEnd
|
|
||||||
ADDQ $1, R15
|
|
||||||
ADDQ $1, SI
|
|
||||||
JMP cmp1
|
|
||||||
|
|
||||||
extendMatchEnd:
|
|
||||||
// Convert from &src[ret] to ret.
|
|
||||||
SUBQ DX, SI
|
|
||||||
MOVQ SI, ret+40(FP)
|
|
||||||
RET
|
|
||||||
|
|
||||||
// ----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
// func encodeBlock(dst, src []byte) (d int)
|
|
||||||
//
|
|
||||||
// All local variables fit into registers, other than "var table". The register
|
|
||||||
// allocation:
|
|
||||||
// - AX . .
|
|
||||||
// - BX . .
|
|
||||||
// - CX 56 shift (note that amd64 shifts by non-immediates must use CX).
|
|
||||||
// - DX 64 &src[0], tableSize
|
|
||||||
// - SI 72 &src[s]
|
|
||||||
// - DI 80 &dst[d]
|
|
||||||
// - R9 88 sLimit
|
|
||||||
// - R10 . &src[nextEmit]
|
|
||||||
// - R11 96 prevHash, currHash, nextHash, offset
|
|
||||||
// - R12 104 &src[base], skip
|
|
||||||
// - R13 . &src[nextS], &src[len(src) - 8]
|
|
||||||
// - R14 . len(src), bytesBetweenHashLookups, &src[len(src)], x
|
|
||||||
// - R15 112 candidate
|
|
||||||
//
|
|
||||||
// The second column (56, 64, etc) is the stack offset to spill the registers
|
|
||||||
// when calling other functions. We could pack this slightly tighter, but it's
|
|
||||||
// simpler to have a dedicated spill map independent of the function called.
|
|
||||||
//
|
|
||||||
// "var table [maxTableSize]uint16" takes up 32768 bytes of stack space. An
|
|
||||||
// extra 56 bytes, to call other functions, and an extra 64 bytes, to spill
|
|
||||||
// local variables (registers) during calls gives 32768 + 56 + 64 = 32888.
|
|
||||||
TEXT ·encodeBlock(SB), 0, $32888-56
|
|
||||||
MOVQ dst_base+0(FP), DI
|
|
||||||
MOVQ src_base+24(FP), SI
|
|
||||||
MOVQ src_len+32(FP), R14
|
|
||||||
|
|
||||||
// shift, tableSize := uint32(32-8), 1<<8
|
|
||||||
MOVQ $24, CX
|
|
||||||
MOVQ $256, DX
|
|
||||||
|
|
||||||
calcShift:
|
|
||||||
// for ; tableSize < maxTableSize && tableSize < len(src); tableSize *= 2 {
|
|
||||||
// shift--
|
|
||||||
// }
|
|
||||||
CMPQ DX, $16384
|
|
||||||
JGE varTable
|
|
||||||
CMPQ DX, R14
|
|
||||||
JGE varTable
|
|
||||||
SUBQ $1, CX
|
|
||||||
SHLQ $1, DX
|
|
||||||
JMP calcShift
|
|
||||||
|
|
||||||
varTable:
|
|
||||||
// var table [maxTableSize]uint16
|
|
||||||
//
|
|
||||||
// In the asm code, unlike the Go code, we can zero-initialize only the
|
|
||||||
// first tableSize elements. Each uint16 element is 2 bytes and each MOVOU
|
|
||||||
// writes 16 bytes, so we can do only tableSize/8 writes instead of the
|
|
||||||
// 2048 writes that would zero-initialize all of table's 32768 bytes.
|
|
||||||
SHRQ $3, DX
|
|
||||||
LEAQ table-32768(SP), BX
|
|
||||||
PXOR X0, X0
|
|
||||||
|
|
||||||
memclr:
|
|
||||||
MOVOU X0, 0(BX)
|
|
||||||
ADDQ $16, BX
|
|
||||||
SUBQ $1, DX
|
|
||||||
JNZ memclr
|
|
||||||
|
|
||||||
// !!! DX = &src[0]
|
|
||||||
MOVQ SI, DX
|
|
||||||
|
|
||||||
// sLimit := len(src) - inputMargin
|
|
||||||
MOVQ R14, R9
|
|
||||||
SUBQ $15, R9
|
|
||||||
|
|
||||||
// !!! Pre-emptively spill CX, DX and R9 to the stack. Their values don't
|
|
||||||
// change for the rest of the function.
|
|
||||||
MOVQ CX, 56(SP)
|
|
||||||
MOVQ DX, 64(SP)
|
|
||||||
MOVQ R9, 88(SP)
|
|
||||||
|
|
||||||
// nextEmit := 0
|
|
||||||
MOVQ DX, R10
|
|
||||||
|
|
||||||
// s := 1
|
|
||||||
ADDQ $1, SI
|
|
||||||
|
|
||||||
// nextHash := hash(load32(src, s), shift)
|
|
||||||
MOVL 0(SI), R11
|
|
||||||
IMULL $0x1e35a7bd, R11
|
|
||||||
SHRL CX, R11
|
|
||||||
|
|
||||||
outer:
|
|
||||||
// for { etc }
|
|
||||||
|
|
||||||
// skip := 32
|
|
||||||
MOVQ $32, R12
|
|
||||||
|
|
||||||
// nextS := s
|
|
||||||
MOVQ SI, R13
|
|
||||||
|
|
||||||
// candidate := 0
|
|
||||||
MOVQ $0, R15
|
|
||||||
|
|
||||||
inner0:
|
|
||||||
// for { etc }
|
|
||||||
|
|
||||||
// s := nextS
|
|
||||||
MOVQ R13, SI
|
|
||||||
|
|
||||||
// bytesBetweenHashLookups := skip >> 5
|
|
||||||
MOVQ R12, R14
|
|
||||||
SHRQ $5, R14
|
|
||||||
|
|
||||||
// nextS = s + bytesBetweenHashLookups
|
|
||||||
ADDQ R14, R13
|
|
||||||
|
|
||||||
// skip += bytesBetweenHashLookups
|
|
||||||
ADDQ R14, R12
|
|
||||||
|
|
||||||
// if nextS > sLimit { goto emitRemainder }
|
|
||||||
MOVQ R13, AX
|
|
||||||
SUBQ DX, AX
|
|
||||||
CMPQ AX, R9
|
|
||||||
JA emitRemainder
|
|
||||||
|
|
||||||
// candidate = int(table[nextHash])
|
|
||||||
// XXX: MOVWQZX table-32768(SP)(R11*2), R15
|
|
||||||
// XXX: 4e 0f b7 7c 5c 78 movzwq 0x78(%rsp,%r11,2),%r15
|
|
||||||
BYTE $0x4e
|
|
||||||
BYTE $0x0f
|
|
||||||
BYTE $0xb7
|
|
||||||
BYTE $0x7c
|
|
||||||
BYTE $0x5c
|
|
||||||
BYTE $0x78
|
|
||||||
|
|
||||||
// table[nextHash] = uint16(s)
|
|
||||||
MOVQ SI, AX
|
|
||||||
SUBQ DX, AX
|
|
||||||
|
|
||||||
// XXX: MOVW AX, table-32768(SP)(R11*2)
|
|
||||||
// XXX: 66 42 89 44 5c 78 mov %ax,0x78(%rsp,%r11,2)
|
|
||||||
BYTE $0x66
|
|
||||||
BYTE $0x42
|
|
||||||
BYTE $0x89
|
|
||||||
BYTE $0x44
|
|
||||||
BYTE $0x5c
|
|
||||||
BYTE $0x78
|
|
||||||
|
|
||||||
// nextHash = hash(load32(src, nextS), shift)
|
|
||||||
MOVL 0(R13), R11
|
|
||||||
IMULL $0x1e35a7bd, R11
|
|
||||||
SHRL CX, R11
|
|
||||||
|
|
||||||
// if load32(src, s) != load32(src, candidate) { continue } break
|
|
||||||
MOVL 0(SI), AX
|
|
||||||
MOVL (DX)(R15*1), BX
|
|
||||||
CMPL AX, BX
|
|
||||||
JNE inner0
|
|
||||||
|
|
||||||
fourByteMatch:
|
|
||||||
// As per the encode_other.go code:
|
|
||||||
//
|
|
||||||
// A 4-byte match has been found. We'll later see etc.
|
|
||||||
|
|
||||||
// !!! Jump to a fast path for short (<= 16 byte) literals. See the comment
|
|
||||||
// on inputMargin in encode.go.
|
|
||||||
MOVQ SI, AX
|
|
||||||
SUBQ R10, AX
|
|
||||||
CMPQ AX, $16
|
|
||||||
JLE emitLiteralFastPath
|
|
||||||
|
|
||||||
// ----------------------------------------
|
|
||||||
// Begin inline of the emitLiteral call.
|
|
||||||
//
|
|
||||||
// d += emitLiteral(dst[d:], src[nextEmit:s])
|
|
||||||
|
|
||||||
MOVL AX, BX
|
|
||||||
SUBL $1, BX
|
|
||||||
|
|
||||||
CMPL BX, $60
|
|
||||||
JLT inlineEmitLiteralOneByte
|
|
||||||
CMPL BX, $256
|
|
||||||
JLT inlineEmitLiteralTwoBytes
|
|
||||||
|
|
||||||
inlineEmitLiteralThreeBytes:
|
|
||||||
MOVB $0xf4, 0(DI)
|
|
||||||
MOVW BX, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
JMP inlineEmitLiteralMemmove
|
|
||||||
|
|
||||||
inlineEmitLiteralTwoBytes:
|
|
||||||
MOVB $0xf0, 0(DI)
|
|
||||||
MOVB BX, 1(DI)
|
|
||||||
ADDQ $2, DI
|
|
||||||
JMP inlineEmitLiteralMemmove
|
|
||||||
|
|
||||||
inlineEmitLiteralOneByte:
|
|
||||||
SHLB $2, BX
|
|
||||||
MOVB BX, 0(DI)
|
|
||||||
ADDQ $1, DI
|
|
||||||
|
|
||||||
inlineEmitLiteralMemmove:
|
|
||||||
// Spill local variables (registers) onto the stack; call; unspill.
|
|
||||||
//
|
|
||||||
// copy(dst[i:], lit)
|
|
||||||
//
|
|
||||||
// This means calling runtime·memmove(&dst[i], &lit[0], len(lit)), so we push
|
|
||||||
// DI, R10 and AX as arguments.
|
|
||||||
MOVQ DI, 0(SP)
|
|
||||||
MOVQ R10, 8(SP)
|
|
||||||
MOVQ AX, 16(SP)
|
|
||||||
ADDQ AX, DI // Finish the "d +=" part of "d += emitLiteral(etc)".
|
|
||||||
MOVQ SI, 72(SP)
|
|
||||||
MOVQ DI, 80(SP)
|
|
||||||
MOVQ R15, 112(SP)
|
|
||||||
CALL runtime·memmove(SB)
|
|
||||||
MOVQ 56(SP), CX
|
|
||||||
MOVQ 64(SP), DX
|
|
||||||
MOVQ 72(SP), SI
|
|
||||||
MOVQ 80(SP), DI
|
|
||||||
MOVQ 88(SP), R9
|
|
||||||
MOVQ 112(SP), R15
|
|
||||||
JMP inner1
|
|
||||||
|
|
||||||
inlineEmitLiteralEnd:
|
|
||||||
// End inline of the emitLiteral call.
|
|
||||||
// ----------------------------------------
|
|
||||||
|
|
||||||
emitLiteralFastPath:
|
|
||||||
// !!! Emit the 1-byte encoding "uint8(len(lit)-1)<<2".
|
|
||||||
MOVB AX, BX
|
|
||||||
SUBB $1, BX
|
|
||||||
SHLB $2, BX
|
|
||||||
MOVB BX, (DI)
|
|
||||||
ADDQ $1, DI
|
|
||||||
|
|
||||||
// !!! Implement the copy from lit to dst as a 16-byte load and store.
|
|
||||||
// (Encode's documentation says that dst and src must not overlap.)
|
|
||||||
//
|
|
||||||
// This always copies 16 bytes, instead of only len(lit) bytes, but that's
|
|
||||||
// OK. Subsequent iterations will fix up the overrun.
|
|
||||||
//
|
|
||||||
// Note that on amd64, it is legal and cheap to issue unaligned 8-byte or
|
|
||||||
// 16-byte loads and stores. This technique probably wouldn't be as
|
|
||||||
// effective on architectures that are fussier about alignment.
|
|
||||||
MOVOU 0(R10), X0
|
|
||||||
MOVOU X0, 0(DI)
|
|
||||||
ADDQ AX, DI
|
|
||||||
|
|
||||||
inner1:
|
|
||||||
// for { etc }
|
|
||||||
|
|
||||||
// base := s
|
|
||||||
MOVQ SI, R12
|
|
||||||
|
|
||||||
// !!! offset := base - candidate
|
|
||||||
MOVQ R12, R11
|
|
||||||
SUBQ R15, R11
|
|
||||||
SUBQ DX, R11
|
|
||||||
|
|
||||||
// ----------------------------------------
|
|
||||||
// Begin inline of the extendMatch call.
|
|
||||||
//
|
|
||||||
// s = extendMatch(src, candidate+4, s+4)
|
|
||||||
|
|
||||||
// !!! R14 = &src[len(src)]
|
|
||||||
MOVQ src_len+32(FP), R14
|
|
||||||
ADDQ DX, R14
|
|
||||||
|
|
||||||
// !!! R13 = &src[len(src) - 8]
|
|
||||||
MOVQ R14, R13
|
|
||||||
SUBQ $8, R13
|
|
||||||
|
|
||||||
// !!! R15 = &src[candidate + 4]
|
|
||||||
ADDQ $4, R15
|
|
||||||
ADDQ DX, R15
|
|
||||||
|
|
||||||
// !!! s += 4
|
|
||||||
ADDQ $4, SI
|
|
||||||
|
|
||||||
inlineExtendMatchCmp8:
|
|
||||||
// As long as we are 8 or more bytes before the end of src, we can load and
|
|
||||||
// compare 8 bytes at a time. If those 8 bytes are equal, repeat.
|
|
||||||
CMPQ SI, R13
|
|
||||||
JA inlineExtendMatchCmp1
|
|
||||||
MOVQ (R15), AX
|
|
||||||
MOVQ (SI), BX
|
|
||||||
CMPQ AX, BX
|
|
||||||
JNE inlineExtendMatchBSF
|
|
||||||
ADDQ $8, R15
|
|
||||||
ADDQ $8, SI
|
|
||||||
JMP inlineExtendMatchCmp8
|
|
||||||
|
|
||||||
inlineExtendMatchBSF:
|
|
||||||
// If those 8 bytes were not equal, XOR the two 8 byte values, and return
|
|
||||||
// the index of the first byte that differs. The BSF instruction finds the
|
|
||||||
// least significant 1 bit, the amd64 architecture is little-endian, and
|
|
||||||
// the shift by 3 converts a bit index to a byte index.
|
|
||||||
XORQ AX, BX
|
|
||||||
BSFQ BX, BX
|
|
||||||
SHRQ $3, BX
|
|
||||||
ADDQ BX, SI
|
|
||||||
JMP inlineExtendMatchEnd
|
|
||||||
|
|
||||||
inlineExtendMatchCmp1:
|
|
||||||
// In src's tail, compare 1 byte at a time.
|
|
||||||
CMPQ SI, R14
|
|
||||||
JAE inlineExtendMatchEnd
|
|
||||||
MOVB (R15), AX
|
|
||||||
MOVB (SI), BX
|
|
||||||
CMPB AX, BX
|
|
||||||
JNE inlineExtendMatchEnd
|
|
||||||
ADDQ $1, R15
|
|
||||||
ADDQ $1, SI
|
|
||||||
JMP inlineExtendMatchCmp1
|
|
||||||
|
|
||||||
inlineExtendMatchEnd:
|
|
||||||
// End inline of the extendMatch call.
|
|
||||||
// ----------------------------------------
|
|
||||||
|
|
||||||
// ----------------------------------------
|
|
||||||
// Begin inline of the emitCopy call.
|
|
||||||
//
|
|
||||||
// d += emitCopy(dst[d:], base-candidate, s-base)
|
|
||||||
|
|
||||||
// !!! length := s - base
|
|
||||||
MOVQ SI, AX
|
|
||||||
SUBQ R12, AX
|
|
||||||
|
|
||||||
inlineEmitCopyLoop0:
|
|
||||||
// for length >= 68 { etc }
|
|
||||||
CMPL AX, $68
|
|
||||||
JLT inlineEmitCopyStep1
|
|
||||||
|
|
||||||
// Emit a length 64 copy, encoded as 3 bytes.
|
|
||||||
MOVB $0xfe, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
SUBL $64, AX
|
|
||||||
JMP inlineEmitCopyLoop0
|
|
||||||
|
|
||||||
inlineEmitCopyStep1:
|
|
||||||
// if length > 64 { etc }
|
|
||||||
CMPL AX, $64
|
|
||||||
JLE inlineEmitCopyStep2
|
|
||||||
|
|
||||||
// Emit a length 60 copy, encoded as 3 bytes.
|
|
||||||
MOVB $0xee, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
SUBL $60, AX
|
|
||||||
|
|
||||||
inlineEmitCopyStep2:
|
|
||||||
// if length >= 12 || offset >= 2048 { goto inlineEmitCopyStep3 }
|
|
||||||
CMPL AX, $12
|
|
||||||
JGE inlineEmitCopyStep3
|
|
||||||
CMPL R11, $2048
|
|
||||||
JGE inlineEmitCopyStep3
|
|
||||||
|
|
||||||
// Emit the remaining copy, encoded as 2 bytes.
|
|
||||||
MOVB R11, 1(DI)
|
|
||||||
SHRL $8, R11
|
|
||||||
SHLB $5, R11
|
|
||||||
SUBB $4, AX
|
|
||||||
SHLB $2, AX
|
|
||||||
ORB AX, R11
|
|
||||||
ORB $1, R11
|
|
||||||
MOVB R11, 0(DI)
|
|
||||||
ADDQ $2, DI
|
|
||||||
JMP inlineEmitCopyEnd
|
|
||||||
|
|
||||||
inlineEmitCopyStep3:
|
|
||||||
// Emit the remaining copy, encoded as 3 bytes.
|
|
||||||
SUBL $1, AX
|
|
||||||
SHLB $2, AX
|
|
||||||
ORB $2, AX
|
|
||||||
MOVB AX, 0(DI)
|
|
||||||
MOVW R11, 1(DI)
|
|
||||||
ADDQ $3, DI
|
|
||||||
|
|
||||||
inlineEmitCopyEnd:
|
|
||||||
// End inline of the emitCopy call.
|
|
||||||
// ----------------------------------------
|
|
||||||
|
|
||||||
// nextEmit = s
|
|
||||||
MOVQ SI, R10
|
|
||||||
|
|
||||||
// if s >= sLimit { goto emitRemainder }
|
|
||||||
MOVQ SI, AX
|
|
||||||
SUBQ DX, AX
|
|
||||||
CMPQ AX, R9
|
|
||||||
JAE emitRemainder
|
|
||||||
|
|
||||||
// As per the encode_other.go code:
|
|
||||||
//
|
|
||||||
// We could immediately etc.
|
|
||||||
|
|
||||||
// x := load64(src, s-1)
|
|
||||||
MOVQ -1(SI), R14
|
|
||||||
|
|
||||||
// prevHash := hash(uint32(x>>0), shift)
|
|
||||||
MOVL R14, R11
|
|
||||||
IMULL $0x1e35a7bd, R11
|
|
||||||
SHRL CX, R11
|
|
||||||
|
|
||||||
// table[prevHash] = uint16(s-1)
|
|
||||||
MOVQ SI, AX
|
|
||||||
SUBQ DX, AX
|
|
||||||
SUBQ $1, AX
|
|
||||||
|
|
||||||
// XXX: MOVW AX, table-32768(SP)(R11*2)
|
|
||||||
// XXX: 66 42 89 44 5c 78 mov %ax,0x78(%rsp,%r11,2)
|
|
||||||
BYTE $0x66
|
|
||||||
BYTE $0x42
|
|
||||||
BYTE $0x89
|
|
||||||
BYTE $0x44
|
|
||||||
BYTE $0x5c
|
|
||||||
BYTE $0x78
|
|
||||||
|
|
||||||
// currHash := hash(uint32(x>>8), shift)
|
|
||||||
SHRQ $8, R14
|
|
||||||
MOVL R14, R11
|
|
||||||
IMULL $0x1e35a7bd, R11
|
|
||||||
SHRL CX, R11
|
|
||||||
|
|
||||||
// candidate = int(table[currHash])
|
|
||||||
// XXX: MOVWQZX table-32768(SP)(R11*2), R15
|
|
||||||
// XXX: 4e 0f b7 7c 5c 78 movzwq 0x78(%rsp,%r11,2),%r15
|
|
||||||
BYTE $0x4e
|
|
||||||
BYTE $0x0f
|
|
||||||
BYTE $0xb7
|
|
||||||
BYTE $0x7c
|
|
||||||
BYTE $0x5c
|
|
||||||
BYTE $0x78
|
|
||||||
|
|
||||||
// table[currHash] = uint16(s)
|
|
||||||
ADDQ $1, AX
|
|
||||||
|
|
||||||
// XXX: MOVW AX, table-32768(SP)(R11*2)
|
|
||||||
// XXX: 66 42 89 44 5c 78 mov %ax,0x78(%rsp,%r11,2)
|
|
||||||
BYTE $0x66
|
|
||||||
BYTE $0x42
|
|
||||||
BYTE $0x89
|
|
||||||
BYTE $0x44
|
|
||||||
BYTE $0x5c
|
|
||||||
BYTE $0x78
|
|
||||||
|
|
||||||
// if uint32(x>>8) == load32(src, candidate) { continue }
|
|
||||||
MOVL (DX)(R15*1), BX
|
|
||||||
CMPL R14, BX
|
|
||||||
JEQ inner1
|
|
||||||
|
|
||||||
// nextHash = hash(uint32(x>>16), shift)
|
|
||||||
SHRQ $8, R14
|
|
||||||
MOVL R14, R11
|
|
||||||
IMULL $0x1e35a7bd, R11
|
|
||||||
SHRL CX, R11
|
|
||||||
|
|
||||||
// s++
|
|
||||||
ADDQ $1, SI
|
|
||||||
|
|
||||||
// break out of the inner1 for loop, i.e. continue the outer loop.
|
|
||||||
JMP outer
|
|
||||||
|
|
||||||
emitRemainder:
|
|
||||||
// if nextEmit < len(src) { etc }
|
|
||||||
MOVQ src_len+32(FP), AX
|
|
||||||
ADDQ DX, AX
|
|
||||||
CMPQ R10, AX
|
|
||||||
JEQ encodeBlockEnd
|
|
||||||
|
|
||||||
// d += emitLiteral(dst[d:], src[nextEmit:])
|
|
||||||
//
|
|
||||||
// Push args.
|
|
||||||
MOVQ DI, 0(SP)
|
|
||||||
MOVQ $0, 8(SP) // Unnecessary, as the callee ignores it, but conservative.
|
|
||||||
MOVQ $0, 16(SP) // Unnecessary, as the callee ignores it, but conservative.
|
|
||||||
MOVQ R10, 24(SP)
|
|
||||||
SUBQ R10, AX
|
|
||||||
MOVQ AX, 32(SP)
|
|
||||||
MOVQ AX, 40(SP) // Unnecessary, as the callee ignores it, but conservative.
|
|
||||||
|
|
||||||
// Spill local variables (registers) onto the stack; call; unspill.
|
|
||||||
MOVQ DI, 80(SP)
|
|
||||||
CALL ·emitLiteral(SB)
|
|
||||||
MOVQ 80(SP), DI
|
|
||||||
|
|
||||||
// Finish the "d +=" part of "d += emitLiteral(etc)".
|
|
||||||
ADDQ 48(SP), DI
|
|
||||||
|
|
||||||
encodeBlockEnd:
|
|
||||||
MOVQ dst_base+0(FP), AX
|
|
||||||
SUBQ AX, DI
|
|
||||||
MOVQ DI, d+48(FP)
|
|
||||||
RET
|
|
238
vendor/github.com/golang/snappy/encode_other.go
generated
vendored
238
vendor/github.com/golang/snappy/encode_other.go
generated
vendored
|
@ -1,238 +0,0 @@
|
||||||
// Copyright 2016 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// +build !amd64 appengine !gc noasm
|
|
||||||
|
|
||||||
package snappy
|
|
||||||
|
|
||||||
func load32(b []byte, i int) uint32 {
|
|
||||||
b = b[i : i+4 : len(b)] // Help the compiler eliminate bounds checks on the next line.
|
|
||||||
return uint32(b[0]) | uint32(b[1])<<8 | uint32(b[2])<<16 | uint32(b[3])<<24
|
|
||||||
}
|
|
||||||
|
|
||||||
func load64(b []byte, i int) uint64 {
|
|
||||||
b = b[i : i+8 : len(b)] // Help the compiler eliminate bounds checks on the next line.
|
|
||||||
return uint64(b[0]) | uint64(b[1])<<8 | uint64(b[2])<<16 | uint64(b[3])<<24 |
|
|
||||||
uint64(b[4])<<32 | uint64(b[5])<<40 | uint64(b[6])<<48 | uint64(b[7])<<56
|
|
||||||
}
|
|
||||||
|
|
||||||
// emitLiteral writes a literal chunk and returns the number of bytes written.
|
|
||||||
//
|
|
||||||
// It assumes that:
|
|
||||||
// dst is long enough to hold the encoded bytes
|
|
||||||
// 1 <= len(lit) && len(lit) <= 65536
|
|
||||||
func emitLiteral(dst, lit []byte) int {
|
|
||||||
i, n := 0, uint(len(lit)-1)
|
|
||||||
switch {
|
|
||||||
case n < 60:
|
|
||||||
dst[0] = uint8(n)<<2 | tagLiteral
|
|
||||||
i = 1
|
|
||||||
case n < 1<<8:
|
|
||||||
dst[0] = 60<<2 | tagLiteral
|
|
||||||
dst[1] = uint8(n)
|
|
||||||
i = 2
|
|
||||||
default:
|
|
||||||
dst[0] = 61<<2 | tagLiteral
|
|
||||||
dst[1] = uint8(n)
|
|
||||||
dst[2] = uint8(n >> 8)
|
|
||||||
i = 3
|
|
||||||
}
|
|
||||||
return i + copy(dst[i:], lit)
|
|
||||||
}
|
|
||||||
|
|
||||||
// emitCopy writes a copy chunk and returns the number of bytes written.
|
|
||||||
//
|
|
||||||
// It assumes that:
|
|
||||||
// dst is long enough to hold the encoded bytes
|
|
||||||
// 1 <= offset && offset <= 65535
|
|
||||||
// 4 <= length && length <= 65535
|
|
||||||
func emitCopy(dst []byte, offset, length int) int {
|
|
||||||
i := 0
|
|
||||||
// The maximum length for a single tagCopy1 or tagCopy2 op is 64 bytes. The
|
|
||||||
// threshold for this loop is a little higher (at 68 = 64 + 4), and the
|
|
||||||
// length emitted down below is is a little lower (at 60 = 64 - 4), because
|
|
||||||
// it's shorter to encode a length 67 copy as a length 60 tagCopy2 followed
|
|
||||||
// by a length 7 tagCopy1 (which encodes as 3+2 bytes) than to encode it as
|
|
||||||
// a length 64 tagCopy2 followed by a length 3 tagCopy2 (which encodes as
|
|
||||||
// 3+3 bytes). The magic 4 in the 64±4 is because the minimum length for a
|
|
||||||
// tagCopy1 op is 4 bytes, which is why a length 3 copy has to be an
|
|
||||||
// encodes-as-3-bytes tagCopy2 instead of an encodes-as-2-bytes tagCopy1.
|
|
||||||
for length >= 68 {
|
|
||||||
// Emit a length 64 copy, encoded as 3 bytes.
|
|
||||||
dst[i+0] = 63<<2 | tagCopy2
|
|
||||||
dst[i+1] = uint8(offset)
|
|
||||||
dst[i+2] = uint8(offset >> 8)
|
|
||||||
i += 3
|
|
||||||
length -= 64
|
|
||||||
}
|
|
||||||
if length > 64 {
|
|
||||||
// Emit a length 60 copy, encoded as 3 bytes.
|
|
||||||
dst[i+0] = 59<<2 | tagCopy2
|
|
||||||
dst[i+1] = uint8(offset)
|
|
||||||
dst[i+2] = uint8(offset >> 8)
|
|
||||||
i += 3
|
|
||||||
length -= 60
|
|
||||||
}
|
|
||||||
if length >= 12 || offset >= 2048 {
|
|
||||||
// Emit the remaining copy, encoded as 3 bytes.
|
|
||||||
dst[i+0] = uint8(length-1)<<2 | tagCopy2
|
|
||||||
dst[i+1] = uint8(offset)
|
|
||||||
dst[i+2] = uint8(offset >> 8)
|
|
||||||
return i + 3
|
|
||||||
}
|
|
||||||
// Emit the remaining copy, encoded as 2 bytes.
|
|
||||||
dst[i+0] = uint8(offset>>8)<<5 | uint8(length-4)<<2 | tagCopy1
|
|
||||||
dst[i+1] = uint8(offset)
|
|
||||||
return i + 2
|
|
||||||
}
|
|
||||||
|
|
||||||
// extendMatch returns the largest k such that k <= len(src) and that
|
|
||||||
// src[i:i+k-j] and src[j:k] have the same contents.
|
|
||||||
//
|
|
||||||
// It assumes that:
|
|
||||||
// 0 <= i && i < j && j <= len(src)
|
|
||||||
func extendMatch(src []byte, i, j int) int {
|
|
||||||
for ; j < len(src) && src[i] == src[j]; i, j = i+1, j+1 {
|
|
||||||
}
|
|
||||||
return j
|
|
||||||
}
|
|
||||||
|
|
||||||
func hash(u, shift uint32) uint32 {
|
|
||||||
return (u * 0x1e35a7bd) >> shift
|
|
||||||
}
|
|
||||||
|
|
||||||
// encodeBlock encodes a non-empty src to a guaranteed-large-enough dst. It
|
|
||||||
// assumes that the varint-encoded length of the decompressed bytes has already
|
|
||||||
// been written.
|
|
||||||
//
|
|
||||||
// It also assumes that:
|
|
||||||
// len(dst) >= MaxEncodedLen(len(src)) &&
|
|
||||||
// minNonLiteralBlockSize <= len(src) && len(src) <= maxBlockSize
|
|
||||||
func encodeBlock(dst, src []byte) (d int) {
|
|
||||||
// Initialize the hash table. Its size ranges from 1<<8 to 1<<14 inclusive.
|
|
||||||
// The table element type is uint16, as s < sLimit and sLimit < len(src)
|
|
||||||
// and len(src) <= maxBlockSize and maxBlockSize == 65536.
|
|
||||||
const (
|
|
||||||
maxTableSize = 1 << 14
|
|
||||||
// tableMask is redundant, but helps the compiler eliminate bounds
|
|
||||||
// checks.
|
|
||||||
tableMask = maxTableSize - 1
|
|
||||||
)
|
|
||||||
shift := uint32(32 - 8)
|
|
||||||
for tableSize := 1 << 8; tableSize < maxTableSize && tableSize < len(src); tableSize *= 2 {
|
|
||||||
shift--
|
|
||||||
}
|
|
||||||
// In Go, all array elements are zero-initialized, so there is no advantage
|
|
||||||
// to a smaller tableSize per se. However, it matches the C++ algorithm,
|
|
||||||
// and in the asm versions of this code, we can get away with zeroing only
|
|
||||||
// the first tableSize elements.
|
|
||||||
var table [maxTableSize]uint16
|
|
||||||
|
|
||||||
// sLimit is when to stop looking for offset/length copies. The inputMargin
|
|
||||||
// lets us use a fast path for emitLiteral in the main loop, while we are
|
|
||||||
// looking for copies.
|
|
||||||
sLimit := len(src) - inputMargin
|
|
||||||
|
|
||||||
// nextEmit is where in src the next emitLiteral should start from.
|
|
||||||
nextEmit := 0
|
|
||||||
|
|
||||||
// The encoded form must start with a literal, as there are no previous
|
|
||||||
// bytes to copy, so we start looking for hash matches at s == 1.
|
|
||||||
s := 1
|
|
||||||
nextHash := hash(load32(src, s), shift)
|
|
||||||
|
|
||||||
for {
|
|
||||||
// Copied from the C++ snappy implementation:
|
|
||||||
//
|
|
||||||
// Heuristic match skipping: If 32 bytes are scanned with no matches
|
|
||||||
// found, start looking only at every other byte. If 32 more bytes are
|
|
||||||
// scanned (or skipped), look at every third byte, etc.. When a match
|
|
||||||
// is found, immediately go back to looking at every byte. This is a
|
|
||||||
// small loss (~5% performance, ~0.1% density) for compressible data
|
|
||||||
// due to more bookkeeping, but for non-compressible data (such as
|
|
||||||
// JPEG) it's a huge win since the compressor quickly "realizes" the
|
|
||||||
// data is incompressible and doesn't bother looking for matches
|
|
||||||
// everywhere.
|
|
||||||
//
|
|
||||||
// The "skip" variable keeps track of how many bytes there are since
|
|
||||||
// the last match; dividing it by 32 (ie. right-shifting by five) gives
|
|
||||||
// the number of bytes to move ahead for each iteration.
|
|
||||||
skip := 32
|
|
||||||
|
|
||||||
nextS := s
|
|
||||||
candidate := 0
|
|
||||||
for {
|
|
||||||
s = nextS
|
|
||||||
bytesBetweenHashLookups := skip >> 5
|
|
||||||
nextS = s + bytesBetweenHashLookups
|
|
||||||
skip += bytesBetweenHashLookups
|
|
||||||
if nextS > sLimit {
|
|
||||||
goto emitRemainder
|
|
||||||
}
|
|
||||||
candidate = int(table[nextHash&tableMask])
|
|
||||||
table[nextHash&tableMask] = uint16(s)
|
|
||||||
nextHash = hash(load32(src, nextS), shift)
|
|
||||||
if load32(src, s) == load32(src, candidate) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A 4-byte match has been found. We'll later see if more than 4 bytes
|
|
||||||
// match. But, prior to the match, src[nextEmit:s] are unmatched. Emit
|
|
||||||
// them as literal bytes.
|
|
||||||
d += emitLiteral(dst[d:], src[nextEmit:s])
|
|
||||||
|
|
||||||
// Call emitCopy, and then see if another emitCopy could be our next
|
|
||||||
// move. Repeat until we find no match for the input immediately after
|
|
||||||
// what was consumed by the last emitCopy call.
|
|
||||||
//
|
|
||||||
// If we exit this loop normally then we need to call emitLiteral next,
|
|
||||||
// though we don't yet know how big the literal will be. We handle that
|
|
||||||
// by proceeding to the next iteration of the main loop. We also can
|
|
||||||
// exit this loop via goto if we get close to exhausting the input.
|
|
||||||
for {
|
|
||||||
// Invariant: we have a 4-byte match at s, and no need to emit any
|
|
||||||
// literal bytes prior to s.
|
|
||||||
base := s
|
|
||||||
|
|
||||||
// Extend the 4-byte match as long as possible.
|
|
||||||
//
|
|
||||||
// This is an inlined version of:
|
|
||||||
// s = extendMatch(src, candidate+4, s+4)
|
|
||||||
s += 4
|
|
||||||
for i := candidate + 4; s < len(src) && src[i] == src[s]; i, s = i+1, s+1 {
|
|
||||||
}
|
|
||||||
|
|
||||||
d += emitCopy(dst[d:], base-candidate, s-base)
|
|
||||||
nextEmit = s
|
|
||||||
if s >= sLimit {
|
|
||||||
goto emitRemainder
|
|
||||||
}
|
|
||||||
|
|
||||||
// We could immediately start working at s now, but to improve
|
|
||||||
// compression we first update the hash table at s-1 and at s. If
|
|
||||||
// another emitCopy is not our next move, also calculate nextHash
|
|
||||||
// at s+1. At least on GOARCH=amd64, these three hash calculations
|
|
||||||
// are faster as one load64 call (with some shifts) instead of
|
|
||||||
// three load32 calls.
|
|
||||||
x := load64(src, s-1)
|
|
||||||
prevHash := hash(uint32(x>>0), shift)
|
|
||||||
table[prevHash&tableMask] = uint16(s - 1)
|
|
||||||
currHash := hash(uint32(x>>8), shift)
|
|
||||||
candidate = int(table[currHash&tableMask])
|
|
||||||
table[currHash&tableMask] = uint16(s)
|
|
||||||
if uint32(x>>8) != load32(src, candidate) {
|
|
||||||
nextHash = hash(uint32(x>>16), shift)
|
|
||||||
s++
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
emitRemainder:
|
|
||||||
if nextEmit < len(src) {
|
|
||||||
d += emitLiteral(dst[d:], src[nextEmit:])
|
|
||||||
}
|
|
||||||
return d
|
|
||||||
}
|
|
98
vendor/github.com/golang/snappy/snappy.go
generated
vendored
98
vendor/github.com/golang/snappy/snappy.go
generated
vendored
|
@ -1,98 +0,0 @@
|
||||||
// Copyright 2011 The Snappy-Go Authors. All rights reserved.
|
|
||||||
// Use of this source code is governed by a BSD-style
|
|
||||||
// license that can be found in the LICENSE file.
|
|
||||||
|
|
||||||
// Package snappy implements the Snappy compression format. It aims for very
|
|
||||||
// high speeds and reasonable compression.
|
|
||||||
//
|
|
||||||
// There are actually two Snappy formats: block and stream. They are related,
|
|
||||||
// but different: trying to decompress block-compressed data as a Snappy stream
|
|
||||||
// will fail, and vice versa. The block format is the Decode and Encode
|
|
||||||
// functions and the stream format is the Reader and Writer types.
|
|
||||||
//
|
|
||||||
// The block format, the more common case, is used when the complete size (the
|
|
||||||
// number of bytes) of the original data is known upfront, at the time
|
|
||||||
// compression starts. The stream format, also known as the framing format, is
|
|
||||||
// for when that isn't always true.
|
|
||||||
//
|
|
||||||
// The canonical, C++ implementation is at https://github.com/google/snappy and
|
|
||||||
// it only implements the block format.
|
|
||||||
package snappy // import "github.com/golang/snappy"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"hash/crc32"
|
|
||||||
)
|
|
||||||
|
|
||||||
/*
|
|
||||||
Each encoded block begins with the varint-encoded length of the decoded data,
|
|
||||||
followed by a sequence of chunks. Chunks begin and end on byte boundaries. The
|
|
||||||
first byte of each chunk is broken into its 2 least and 6 most significant bits
|
|
||||||
called l and m: l ranges in [0, 4) and m ranges in [0, 64). l is the chunk tag.
|
|
||||||
Zero means a literal tag. All other values mean a copy tag.
|
|
||||||
|
|
||||||
For literal tags:
|
|
||||||
- If m < 60, the next 1 + m bytes are literal bytes.
|
|
||||||
- Otherwise, let n be the little-endian unsigned integer denoted by the next
|
|
||||||
m - 59 bytes. The next 1 + n bytes after that are literal bytes.
|
|
||||||
|
|
||||||
For copy tags, length bytes are copied from offset bytes ago, in the style of
|
|
||||||
Lempel-Ziv compression algorithms. In particular:
|
|
||||||
- For l == 1, the offset ranges in [0, 1<<11) and the length in [4, 12).
|
|
||||||
The length is 4 + the low 3 bits of m. The high 3 bits of m form bits 8-10
|
|
||||||
of the offset. The next byte is bits 0-7 of the offset.
|
|
||||||
- For l == 2, the offset ranges in [0, 1<<16) and the length in [1, 65).
|
|
||||||
The length is 1 + m. The offset is the little-endian unsigned integer
|
|
||||||
denoted by the next 2 bytes.
|
|
||||||
- For l == 3, this tag is a legacy format that is no longer issued by most
|
|
||||||
encoders. Nonetheless, the offset ranges in [0, 1<<32) and the length in
|
|
||||||
[1, 65). The length is 1 + m. The offset is the little-endian unsigned
|
|
||||||
integer denoted by the next 4 bytes.
|
|
||||||
*/
|
|
||||||
const (
|
|
||||||
tagLiteral = 0x00
|
|
||||||
tagCopy1 = 0x01
|
|
||||||
tagCopy2 = 0x02
|
|
||||||
tagCopy4 = 0x03
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
checksumSize = 4
|
|
||||||
chunkHeaderSize = 4
|
|
||||||
magicChunk = "\xff\x06\x00\x00" + magicBody
|
|
||||||
magicBody = "sNaPpY"
|
|
||||||
|
|
||||||
// maxBlockSize is the maximum size of the input to encodeBlock. It is not
|
|
||||||
// part of the wire format per se, but some parts of the encoder assume
|
|
||||||
// that an offset fits into a uint16.
|
|
||||||
//
|
|
||||||
// Also, for the framing format (Writer type instead of Encode function),
|
|
||||||
// https://github.com/google/snappy/blob/master/framing_format.txt says
|
|
||||||
// that "the uncompressed data in a chunk must be no longer than 65536
|
|
||||||
// bytes".
|
|
||||||
maxBlockSize = 65536
|
|
||||||
|
|
||||||
// maxEncodedLenOfMaxBlockSize equals MaxEncodedLen(maxBlockSize), but is
|
|
||||||
// hard coded to be a const instead of a variable, so that obufLen can also
|
|
||||||
// be a const. Their equivalence is confirmed by
|
|
||||||
// TestMaxEncodedLenOfMaxBlockSize.
|
|
||||||
maxEncodedLenOfMaxBlockSize = 76490
|
|
||||||
|
|
||||||
obufHeaderLen = len(magicChunk) + checksumSize + chunkHeaderSize
|
|
||||||
obufLen = obufHeaderLen + maxEncodedLenOfMaxBlockSize
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
chunkTypeCompressedData = 0x00
|
|
||||||
chunkTypeUncompressedData = 0x01
|
|
||||||
chunkTypePadding = 0xfe
|
|
||||||
chunkTypeStreamIdentifier = 0xff
|
|
||||||
)
|
|
||||||
|
|
||||||
var crcTable = crc32.MakeTable(crc32.Castagnoli)
|
|
||||||
|
|
||||||
// crc implements the checksum specified in section 3 of
|
|
||||||
// https://github.com/google/snappy/blob/master/framing_format.txt
|
|
||||||
func crc(b []byte) uint32 {
|
|
||||||
c := crc32.Update(0, crcTable, b)
|
|
||||||
return uint32(c>>15|c<<17) + 0xa282ead8
|
|
||||||
}
|
|
354
vendor/github.com/hashicorp/errwrap/LICENSE
generated
vendored
354
vendor/github.com/hashicorp/errwrap/LICENSE
generated
vendored
|
@ -1,354 +0,0 @@
|
||||||
Mozilla Public License, version 2.0
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
|
|
||||||
1.1. “Contributor”
|
|
||||||
|
|
||||||
means each individual or legal entity that creates, contributes to the
|
|
||||||
creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. “Contributor Version”
|
|
||||||
|
|
||||||
means the combination of the Contributions of others (if any) used by a
|
|
||||||
Contributor and that particular Contributor’s Contribution.
|
|
||||||
|
|
||||||
1.3. “Contribution”
|
|
||||||
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. “Covered Software”
|
|
||||||
|
|
||||||
means Source Code Form to which the initial Contributor has attached the
|
|
||||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
||||||
Modifications of such Source Code Form, in each case including portions
|
|
||||||
thereof.
|
|
||||||
|
|
||||||
1.5. “Incompatible With Secondary Licenses”
|
|
||||||
means
|
|
||||||
|
|
||||||
a. that the initial Contributor has attached the notice described in
|
|
||||||
Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
b. that the Covered Software was made available under the terms of version
|
|
||||||
1.1 or earlier of the License, but not also under the terms of a
|
|
||||||
Secondary License.
|
|
||||||
|
|
||||||
1.6. “Executable Form”
|
|
||||||
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. “Larger Work”
|
|
||||||
|
|
||||||
means a work that combines Covered Software with other material, in a separate
|
|
||||||
file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. “License”
|
|
||||||
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. “Licensable”
|
|
||||||
|
|
||||||
means having the right to grant, to the maximum extent possible, whether at the
|
|
||||||
time of the initial grant or subsequently, any and all of the rights conveyed by
|
|
||||||
this License.
|
|
||||||
|
|
||||||
1.10. “Modifications”
|
|
||||||
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
a. any file in Source Code Form that results from an addition to, deletion
|
|
||||||
from, or modification of the contents of Covered Software; or
|
|
||||||
|
|
||||||
b. any new file in Source Code Form that contains any Covered Software.
|
|
||||||
|
|
||||||
1.11. “Patent Claims” of a Contributor
|
|
||||||
|
|
||||||
means any patent claim(s), including without limitation, method, process,
|
|
||||||
and apparatus claims, in any patent Licensable by such Contributor that
|
|
||||||
would be infringed, but for the grant of the License, by the making,
|
|
||||||
using, selling, offering for sale, having made, import, or transfer of
|
|
||||||
either its Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
1.12. “Secondary License”
|
|
||||||
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
||||||
General Public License, Version 2.1, the GNU Affero General Public
|
|
||||||
License, Version 3.0, or any later versions of those licenses.
|
|
||||||
|
|
||||||
1.13. “Source Code Form”
|
|
||||||
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. “You” (or “Your”)
|
|
||||||
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, “You” includes any entity that controls, is
|
|
||||||
controlled by, or is under common control with You. For purposes of this
|
|
||||||
definition, “control” means (a) the power, direct or indirect, to cause
|
|
||||||
the direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
||||||
outstanding shares or beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
a. under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or as
|
|
||||||
part of a Larger Work; and
|
|
||||||
|
|
||||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
||||||
sale, have made, import, and otherwise transfer either its Contributions
|
|
||||||
or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution become
|
|
||||||
effective for each Contribution on the date the Contributor first distributes
|
|
||||||
such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under this
|
|
||||||
License. No additional rights or licenses will be implied from the distribution
|
|
||||||
or licensing of Covered Software under this License. Notwithstanding Section
|
|
||||||
2.1(b) above, no patent license is granted by a Contributor:
|
|
||||||
|
|
||||||
a. for any code that a Contributor has removed from Covered Software; or
|
|
||||||
|
|
||||||
b. for infringements caused by: (i) Your and any other third party’s
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
c. under Patent Claims infringed by Covered Software in the absence of its
|
|
||||||
Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks, or
|
|
||||||
logos of any Contributor (except as may be necessary to comply with the
|
|
||||||
notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this License
|
|
||||||
(see Section 10.2) or under the terms of a Secondary License (if permitted
|
|
||||||
under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its Contributions
|
|
||||||
are its original creation(s) or it has sufficient rights to grant the
|
|
||||||
rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under applicable
|
|
||||||
copyright doctrines of fair use, fair dealing, or other equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
||||||
Section 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under the
|
|
||||||
terms of this License. You must inform recipients that the Source Code Form
|
|
||||||
of the Covered Software is governed by the terms of this License, and how
|
|
||||||
they can obtain a copy of this License. You may not attempt to alter or
|
|
||||||
restrict the recipients’ rights in the Source Code Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
a. such Covered Software must also be made available in Source Code Form,
|
|
||||||
as described in Section 3.1, and You must inform recipients of the
|
|
||||||
Executable Form how they can obtain a copy of such Source Code Form by
|
|
||||||
reasonable means in a timely manner, at a charge no more than the cost
|
|
||||||
of distribution to the recipient; and
|
|
||||||
|
|
||||||
b. You may distribute such Executable Form under the terms of this License,
|
|
||||||
or sublicense it under different terms, provided that the license for
|
|
||||||
the Executable Form does not attempt to limit or alter the recipients’
|
|
||||||
rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for the
|
|
||||||
Covered Software. If the Larger Work is a combination of Covered Software
|
|
||||||
with a work governed by one or more Secondary Licenses, and the Covered
|
|
||||||
Software is not Incompatible With Secondary Licenses, this License permits
|
|
||||||
You to additionally distribute such Covered Software under the terms of
|
|
||||||
such Secondary License(s), so that the recipient of the Larger Work may, at
|
|
||||||
their option, further distribute the Covered Software under the terms of
|
|
||||||
either this License or such Secondary License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices (including
|
|
||||||
copyright notices, patent notices, disclaimers of warranty, or limitations
|
|
||||||
of liability) contained within the Source Code Form of the Covered
|
|
||||||
Software, except that You may alter any license notices to the extent
|
|
||||||
required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on behalf
|
|
||||||
of any Contributor. You must make it absolutely clear that any such
|
|
||||||
warranty, support, indemnity, or liability obligation is offered by You
|
|
||||||
alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this License
|
|
||||||
with respect to some or all of the Covered Software due to statute, judicial
|
|
||||||
order, or regulation then You must: (a) comply with the terms of this License
|
|
||||||
to the maximum extent possible; and (b) describe the limitations and the code
|
|
||||||
they affect. Such description must be placed in a text file included with all
|
|
||||||
distributions of the Covered Software under this License. Except to the
|
|
||||||
extent prohibited by statute or regulation, such description must be
|
|
||||||
sufficiently detailed for a recipient of ordinary skill to be able to
|
|
||||||
understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically if You
|
|
||||||
fail to comply with any of its terms. However, if You become compliant,
|
|
||||||
then the rights granted under this License from a particular Contributor
|
|
||||||
are reinstated (a) provisionally, unless and until such Contributor
|
|
||||||
explicitly and finally terminates Your grants, and (b) on an ongoing basis,
|
|
||||||
if such Contributor fails to notify You of the non-compliance by some
|
|
||||||
reasonable means prior to 60 days after You have come back into compliance.
|
|
||||||
Moreover, Your grants from a particular Contributor are reinstated on an
|
|
||||||
ongoing basis if such Contributor notifies You of the non-compliance by
|
|
||||||
some reasonable means, this is the first time You have received notice of
|
|
||||||
non-compliance with this License from such Contributor, and You become
|
|
||||||
compliant prior to 30 days after Your receipt of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions, counter-claims,
|
|
||||||
and cross-claims) alleging that a Contributor Version directly or
|
|
||||||
indirectly infringes any patent, then the rights granted to You by any and
|
|
||||||
all Contributors for the Covered Software under Section 2.1 of this License
|
|
||||||
shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
||||||
license agreements (excluding distributors and resellers) which have been
|
|
||||||
validly granted by You or Your distributors under this License prior to
|
|
||||||
termination shall survive termination.
|
|
||||||
|
|
||||||
6. Disclaimer of Warranty
|
|
||||||
|
|
||||||
Covered Software is provided under this License on an “as is” basis, without
|
|
||||||
warranty of any kind, either expressed, implied, or statutory, including,
|
|
||||||
without limitation, warranties that the Covered Software is free of defects,
|
|
||||||
merchantable, fit for a particular purpose or non-infringing. The entire
|
|
||||||
risk as to the quality and performance of the Covered Software is with You.
|
|
||||||
Should any Covered Software prove defective in any respect, You (not any
|
|
||||||
Contributor) assume the cost of any necessary servicing, repair, or
|
|
||||||
correction. This disclaimer of warranty constitutes an essential part of this
|
|
||||||
License. No use of any Covered Software is authorized under this License
|
|
||||||
except under this disclaimer.
|
|
||||||
|
|
||||||
7. Limitation of Liability
|
|
||||||
|
|
||||||
Under no circumstances and under no legal theory, whether tort (including
|
|
||||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
||||||
distributes Covered Software as permitted above, be liable to You for any
|
|
||||||
direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character including, without limitation, damages for lost profits, loss of
|
|
||||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses, even if such party shall have been
|
|
||||||
informed of the possibility of such damages. This limitation of liability
|
|
||||||
shall not apply to liability for death or personal injury resulting from such
|
|
||||||
party’s negligence to the extent applicable law prohibits such limitation.
|
|
||||||
Some jurisdictions do not allow the exclusion or limitation of incidental or
|
|
||||||
consequential damages, so this exclusion and limitation may not apply to You.
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the courts of
|
|
||||||
a jurisdiction where the defendant maintains its principal place of business
|
|
||||||
and such litigation shall be governed by laws of that jurisdiction, without
|
|
||||||
reference to its conflict-of-law provisions. Nothing in this Section shall
|
|
||||||
prevent a party’s ability to bring cross-claims or counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject matter
|
|
||||||
hereof. If any provision of this License is held to be unenforceable, such
|
|
||||||
provision shall be reformed only to the extent necessary to make it
|
|
||||||
enforceable. Any law or regulation which provides that the language of a
|
|
||||||
contract shall be construed against the drafter shall not be used to construe
|
|
||||||
this License against a Contributor.
|
|
||||||
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version of
|
|
||||||
the License under which You originally received the Covered Software, or
|
|
||||||
under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a modified
|
|
||||||
version of this License if you rename the license and remove any
|
|
||||||
references to the name of the license steward (except to note that such
|
|
||||||
modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
|
|
||||||
If You choose to distribute Source Code Form that is Incompatible With
|
|
||||||
Secondary Licenses under the terms of this version of the License, the
|
|
||||||
notice described in Exhibit B of this License must be attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
|
|
||||||
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
|
|
||||||
http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular file, then
|
|
||||||
You may include the notice in a location (such as a LICENSE file in a relevant
|
|
||||||
directory) where a recipient would be likely to look for such a notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - “Incompatible With Secondary Licenses” Notice
|
|
||||||
|
|
||||||
This Source Code Form is “Incompatible
|
|
||||||
With Secondary Licenses”, as defined by
|
|
||||||
the Mozilla Public License, v. 2.0.
|
|
||||||
|
|
89
vendor/github.com/hashicorp/errwrap/README.md
generated
vendored
89
vendor/github.com/hashicorp/errwrap/README.md
generated
vendored
|
@ -1,89 +0,0 @@
|
||||||
# errwrap
|
|
||||||
|
|
||||||
`errwrap` is a package for Go that formalizes the pattern of wrapping errors
|
|
||||||
and checking if an error contains another error.
|
|
||||||
|
|
||||||
There is a common pattern in Go of taking a returned `error` value and
|
|
||||||
then wrapping it (such as with `fmt.Errorf`) before returning it. The problem
|
|
||||||
with this pattern is that you completely lose the original `error` structure.
|
|
||||||
|
|
||||||
Arguably the _correct_ approach is that you should make a custom structure
|
|
||||||
implementing the `error` interface, and have the original error as a field
|
|
||||||
on that structure, such [as this example](http://golang.org/pkg/os/#PathError).
|
|
||||||
This is a good approach, but you have to know the entire chain of possible
|
|
||||||
rewrapping that happens, when you might just care about one.
|
|
||||||
|
|
||||||
`errwrap` formalizes this pattern (it doesn't matter what approach you use
|
|
||||||
above) by giving a single interface for wrapping errors, checking if a specific
|
|
||||||
error is wrapped, and extracting that error.
|
|
||||||
|
|
||||||
## Installation and Docs
|
|
||||||
|
|
||||||
Install using `go get github.com/hashicorp/errwrap`.
|
|
||||||
|
|
||||||
Full documentation is available at
|
|
||||||
http://godoc.org/github.com/hashicorp/errwrap
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
#### Basic Usage
|
|
||||||
|
|
||||||
Below is a very basic example of its usage:
|
|
||||||
|
|
||||||
```go
|
|
||||||
// A function that always returns an error, but wraps it, like a real
|
|
||||||
// function might.
|
|
||||||
func tryOpen() error {
|
|
||||||
_, err := os.Open("/i/dont/exist")
|
|
||||||
if err != nil {
|
|
||||||
return errwrap.Wrapf("Doesn't exist: {{err}}", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
err := tryOpen()
|
|
||||||
|
|
||||||
// We can use the Contains helpers to check if an error contains
|
|
||||||
// another error. It is safe to do this with a nil error, or with
|
|
||||||
// an error that doesn't even use the errwrap package.
|
|
||||||
if errwrap.Contains(err, "does not exist") {
|
|
||||||
// Do something
|
|
||||||
}
|
|
||||||
if errwrap.ContainsType(err, new(os.PathError)) {
|
|
||||||
// Do something
|
|
||||||
}
|
|
||||||
|
|
||||||
// Or we can use the associated `Get` functions to just extract
|
|
||||||
// a specific error. This would return nil if that specific error doesn't
|
|
||||||
// exist.
|
|
||||||
perr := errwrap.GetType(err, new(os.PathError))
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Custom Types
|
|
||||||
|
|
||||||
If you're already making custom types that properly wrap errors, then
|
|
||||||
you can get all the functionality of `errwraps.Contains` and such by
|
|
||||||
implementing the `Wrapper` interface with just one function. Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type AppError {
|
|
||||||
Code ErrorCode
|
|
||||||
Err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *AppError) WrappedErrors() []error {
|
|
||||||
return []error{e.Err}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Now this works:
|
|
||||||
|
|
||||||
```go
|
|
||||||
err := &AppError{Err: fmt.Errorf("an error")}
|
|
||||||
if errwrap.ContainsType(err, fmt.Errorf("")) {
|
|
||||||
// This will work!
|
|
||||||
}
|
|
||||||
```
|
|
169
vendor/github.com/hashicorp/errwrap/errwrap.go
generated
vendored
169
vendor/github.com/hashicorp/errwrap/errwrap.go
generated
vendored
|
@ -1,169 +0,0 @@
|
||||||
// Package errwrap implements methods to formalize error wrapping in Go.
|
|
||||||
//
|
|
||||||
// All of the top-level functions that take an `error` are built to be able
|
|
||||||
// to take any error, not just wrapped errors. This allows you to use errwrap
|
|
||||||
// without having to type-check and type-cast everywhere.
|
|
||||||
package errwrap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// WalkFunc is the callback called for Walk.
|
|
||||||
type WalkFunc func(error)
|
|
||||||
|
|
||||||
// Wrapper is an interface that can be implemented by custom types to
|
|
||||||
// have all the Contains, Get, etc. functions in errwrap work.
|
|
||||||
//
|
|
||||||
// When Walk reaches a Wrapper, it will call the callback for every
|
|
||||||
// wrapped error in addition to the wrapper itself. Since all the top-level
|
|
||||||
// functions in errwrap use Walk, this means that all those functions work
|
|
||||||
// with your custom type.
|
|
||||||
type Wrapper interface {
|
|
||||||
WrappedErrors() []error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wrap defines that outer wraps inner, returning an error type that
|
|
||||||
// can be cleanly used with the other methods in this package, such as
|
|
||||||
// Contains, GetAll, etc.
|
|
||||||
//
|
|
||||||
// This function won't modify the error message at all (the outer message
|
|
||||||
// will be used).
|
|
||||||
func Wrap(outer, inner error) error {
|
|
||||||
return &wrappedError{
|
|
||||||
Outer: outer,
|
|
||||||
Inner: inner,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wrapf wraps an error with a formatting message. This is similar to using
|
|
||||||
// `fmt.Errorf` to wrap an error. If you're using `fmt.Errorf` to wrap
|
|
||||||
// errors, you should replace it with this.
|
|
||||||
//
|
|
||||||
// format is the format of the error message. The string '{{err}}' will
|
|
||||||
// be replaced with the original error message.
|
|
||||||
func Wrapf(format string, err error) error {
|
|
||||||
outerMsg := "<nil>"
|
|
||||||
if err != nil {
|
|
||||||
outerMsg = err.Error()
|
|
||||||
}
|
|
||||||
|
|
||||||
outer := errors.New(strings.Replace(
|
|
||||||
format, "{{err}}", outerMsg, -1))
|
|
||||||
|
|
||||||
return Wrap(outer, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Contains checks if the given error contains an error with the
|
|
||||||
// message msg. If err is not a wrapped error, this will always return
|
|
||||||
// false unless the error itself happens to match this msg.
|
|
||||||
func Contains(err error, msg string) bool {
|
|
||||||
return len(GetAll(err, msg)) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsType checks if the given error contains an error with
|
|
||||||
// the same concrete type as v. If err is not a wrapped error, this will
|
|
||||||
// check the err itself.
|
|
||||||
func ContainsType(err error, v interface{}) bool {
|
|
||||||
return len(GetAllType(err, v)) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get is the same as GetAll but returns the deepest matching error.
|
|
||||||
func Get(err error, msg string) error {
|
|
||||||
es := GetAll(err, msg)
|
|
||||||
if len(es) > 0 {
|
|
||||||
return es[len(es)-1]
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetType is the same as GetAllType but returns the deepest matching error.
|
|
||||||
func GetType(err error, v interface{}) error {
|
|
||||||
es := GetAllType(err, v)
|
|
||||||
if len(es) > 0 {
|
|
||||||
return es[len(es)-1]
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAll gets all the errors that might be wrapped in err with the
|
|
||||||
// given message. The order of the errors is such that the outermost
|
|
||||||
// matching error (the most recent wrap) is index zero, and so on.
|
|
||||||
func GetAll(err error, msg string) []error {
|
|
||||||
var result []error
|
|
||||||
|
|
||||||
Walk(err, func(err error) {
|
|
||||||
if err.Error() == msg {
|
|
||||||
result = append(result, err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAllType gets all the errors that are the same type as v.
|
|
||||||
//
|
|
||||||
// The order of the return value is the same as described in GetAll.
|
|
||||||
func GetAllType(err error, v interface{}) []error {
|
|
||||||
var result []error
|
|
||||||
|
|
||||||
var search string
|
|
||||||
if v != nil {
|
|
||||||
search = reflect.TypeOf(v).String()
|
|
||||||
}
|
|
||||||
Walk(err, func(err error) {
|
|
||||||
var needle string
|
|
||||||
if err != nil {
|
|
||||||
needle = reflect.TypeOf(err).String()
|
|
||||||
}
|
|
||||||
|
|
||||||
if needle == search {
|
|
||||||
result = append(result, err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
// Walk walks all the wrapped errors in err and calls the callback. If
|
|
||||||
// err isn't a wrapped error, this will be called once for err. If err
|
|
||||||
// is a wrapped error, the callback will be called for both the wrapper
|
|
||||||
// that implements error as well as the wrapped error itself.
|
|
||||||
func Walk(err error, cb WalkFunc) {
|
|
||||||
if err == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
switch e := err.(type) {
|
|
||||||
case *wrappedError:
|
|
||||||
cb(e.Outer)
|
|
||||||
Walk(e.Inner, cb)
|
|
||||||
case Wrapper:
|
|
||||||
cb(err)
|
|
||||||
|
|
||||||
for _, err := range e.WrappedErrors() {
|
|
||||||
Walk(err, cb)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
cb(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// wrappedError is an implementation of error that has both the
|
|
||||||
// outer and inner errors.
|
|
||||||
type wrappedError struct {
|
|
||||||
Outer error
|
|
||||||
Inner error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *wrappedError) Error() string {
|
|
||||||
return w.Outer.Error()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *wrappedError) WrappedErrors() []error {
|
|
||||||
return []error{w.Outer, w.Inner}
|
|
||||||
}
|
|
1
vendor/github.com/hashicorp/errwrap/go.mod
generated
vendored
1
vendor/github.com/hashicorp/errwrap/go.mod
generated
vendored
|
@ -1 +0,0 @@
|
||||||
module github.com/hashicorp/errwrap
|
|
363
vendor/github.com/hashicorp/go-cleanhttp/LICENSE
generated
vendored
363
vendor/github.com/hashicorp/go-cleanhttp/LICENSE
generated
vendored
|
@ -1,363 +0,0 @@
|
||||||
Mozilla Public License, version 2.0
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
|
|
||||||
1.1. "Contributor"
|
|
||||||
|
|
||||||
means each individual or legal entity that creates, contributes to the
|
|
||||||
creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. "Contributor Version"
|
|
||||||
|
|
||||||
means the combination of the Contributions of others (if any) used by a
|
|
||||||
Contributor and that particular Contributor's Contribution.
|
|
||||||
|
|
||||||
1.3. "Contribution"
|
|
||||||
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. "Covered Software"
|
|
||||||
|
|
||||||
means Source Code Form to which the initial Contributor has attached the
|
|
||||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
||||||
Modifications of such Source Code Form, in each case including portions
|
|
||||||
thereof.
|
|
||||||
|
|
||||||
1.5. "Incompatible With Secondary Licenses"
|
|
||||||
means
|
|
||||||
|
|
||||||
a. that the initial Contributor has attached the notice described in
|
|
||||||
Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
b. that the Covered Software was made available under the terms of
|
|
||||||
version 1.1 or earlier of the License, but not also under the terms of
|
|
||||||
a Secondary License.
|
|
||||||
|
|
||||||
1.6. "Executable Form"
|
|
||||||
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. "Larger Work"
|
|
||||||
|
|
||||||
means a work that combines Covered Software with other material, in a
|
|
||||||
separate file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. "License"
|
|
||||||
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. "Licensable"
|
|
||||||
|
|
||||||
means having the right to grant, to the maximum extent possible, whether
|
|
||||||
at the time of the initial grant or subsequently, any and all of the
|
|
||||||
rights conveyed by this License.
|
|
||||||
|
|
||||||
1.10. "Modifications"
|
|
||||||
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
a. any file in Source Code Form that results from an addition to,
|
|
||||||
deletion from, or modification of the contents of Covered Software; or
|
|
||||||
|
|
||||||
b. any new file in Source Code Form that contains any Covered Software.
|
|
||||||
|
|
||||||
1.11. "Patent Claims" of a Contributor
|
|
||||||
|
|
||||||
means any patent claim(s), including without limitation, method,
|
|
||||||
process, and apparatus claims, in any patent Licensable by such
|
|
||||||
Contributor that would be infringed, but for the grant of the License,
|
|
||||||
by the making, using, selling, offering for sale, having made, import,
|
|
||||||
or transfer of either its Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
1.12. "Secondary License"
|
|
||||||
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
||||||
General Public License, Version 2.1, the GNU Affero General Public
|
|
||||||
License, Version 3.0, or any later versions of those licenses.
|
|
||||||
|
|
||||||
1.13. "Source Code Form"
|
|
||||||
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. "You" (or "Your")
|
|
||||||
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, "You" includes any entity that controls, is
|
|
||||||
controlled by, or is under common control with You. For purposes of this
|
|
||||||
definition, "control" means (a) the power, direct or indirect, to cause
|
|
||||||
the direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
||||||
outstanding shares or beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
a. under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or
|
|
||||||
as part of a Larger Work; and
|
|
||||||
|
|
||||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
||||||
sale, have made, import, and otherwise transfer either its
|
|
||||||
Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution
|
|
||||||
become effective for each Contribution on the date the Contributor first
|
|
||||||
distributes such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under
|
|
||||||
this License. No additional rights or licenses will be implied from the
|
|
||||||
distribution or licensing of Covered Software under this License.
|
|
||||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
||||||
Contributor:
|
|
||||||
|
|
||||||
a. for any code that a Contributor has removed from Covered Software; or
|
|
||||||
|
|
||||||
b. for infringements caused by: (i) Your and any other third party's
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
c. under Patent Claims infringed by Covered Software in the absence of
|
|
||||||
its Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks,
|
|
||||||
or logos of any Contributor (except as may be necessary to comply with
|
|
||||||
the notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this
|
|
||||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
||||||
permitted under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its
|
|
||||||
Contributions are its original creation(s) or it has sufficient rights to
|
|
||||||
grant the rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under
|
|
||||||
applicable copyright doctrines of fair use, fair dealing, or other
|
|
||||||
equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
||||||
Section 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under
|
|
||||||
the terms of this License. You must inform recipients that the Source
|
|
||||||
Code Form of the Covered Software is governed by the terms of this
|
|
||||||
License, and how they can obtain a copy of this License. You may not
|
|
||||||
attempt to alter or restrict the recipients' rights in the Source Code
|
|
||||||
Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
a. such Covered Software must also be made available in Source Code Form,
|
|
||||||
as described in Section 3.1, and You must inform recipients of the
|
|
||||||
Executable Form how they can obtain a copy of such Source Code Form by
|
|
||||||
reasonable means in a timely manner, at a charge no more than the cost
|
|
||||||
of distribution to the recipient; and
|
|
||||||
|
|
||||||
b. You may distribute such Executable Form under the terms of this
|
|
||||||
License, or sublicense it under different terms, provided that the
|
|
||||||
license for the Executable Form does not attempt to limit or alter the
|
|
||||||
recipients' rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for
|
|
||||||
the Covered Software. If the Larger Work is a combination of Covered
|
|
||||||
Software with a work governed by one or more Secondary Licenses, and the
|
|
||||||
Covered Software is not Incompatible With Secondary Licenses, this
|
|
||||||
License permits You to additionally distribute such Covered Software
|
|
||||||
under the terms of such Secondary License(s), so that the recipient of
|
|
||||||
the Larger Work may, at their option, further distribute the Covered
|
|
||||||
Software under the terms of either this License or such Secondary
|
|
||||||
License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices
|
|
||||||
(including copyright notices, patent notices, disclaimers of warranty, or
|
|
||||||
limitations of liability) contained within the Source Code Form of the
|
|
||||||
Covered Software, except that You may alter any license notices to the
|
|
||||||
extent required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on
|
|
||||||
behalf of any Contributor. You must make it absolutely clear that any
|
|
||||||
such warranty, support, indemnity, or liability obligation is offered by
|
|
||||||
You alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this License
|
|
||||||
with respect to some or all of the Covered Software due to statute,
|
|
||||||
judicial order, or regulation then You must: (a) comply with the terms of
|
|
||||||
this License to the maximum extent possible; and (b) describe the
|
|
||||||
limitations and the code they affect. Such description must be placed in a
|
|
||||||
text file included with all distributions of the Covered Software under
|
|
||||||
this License. Except to the extent prohibited by statute or regulation,
|
|
||||||
such description must be sufficiently detailed for a recipient of ordinary
|
|
||||||
skill to be able to understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically if You
|
|
||||||
fail to comply with any of its terms. However, if You become compliant,
|
|
||||||
then the rights granted under this License from a particular Contributor
|
|
||||||
are reinstated (a) provisionally, unless and until such Contributor
|
|
||||||
explicitly and finally terminates Your grants, and (b) on an ongoing
|
|
||||||
basis, if such Contributor fails to notify You of the non-compliance by
|
|
||||||
some reasonable means prior to 60 days after You have come back into
|
|
||||||
compliance. Moreover, Your grants from a particular Contributor are
|
|
||||||
reinstated on an ongoing basis if such Contributor notifies You of the
|
|
||||||
non-compliance by some reasonable means, this is the first time You have
|
|
||||||
received notice of non-compliance with this License from such
|
|
||||||
Contributor, and You become compliant prior to 30 days after Your receipt
|
|
||||||
of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions,
|
|
||||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
||||||
directly or indirectly infringes any patent, then the rights granted to
|
|
||||||
You by any and all Contributors for the Covered Software under Section
|
|
||||||
2.1 of this License shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
||||||
license agreements (excluding distributors and resellers) which have been
|
|
||||||
validly granted by You or Your distributors under this License prior to
|
|
||||||
termination shall survive termination.
|
|
||||||
|
|
||||||
6. Disclaimer of Warranty
|
|
||||||
|
|
||||||
Covered Software is provided under this License on an "as is" basis,
|
|
||||||
without warranty of any kind, either expressed, implied, or statutory,
|
|
||||||
including, without limitation, warranties that the Covered Software is free
|
|
||||||
of defects, merchantable, fit for a particular purpose or non-infringing.
|
|
||||||
The entire risk as to the quality and performance of the Covered Software
|
|
||||||
is with You. Should any Covered Software prove defective in any respect,
|
|
||||||
You (not any Contributor) assume the cost of any necessary servicing,
|
|
||||||
repair, or correction. This disclaimer of warranty constitutes an essential
|
|
||||||
part of this License. No use of any Covered Software is authorized under
|
|
||||||
this License except under this disclaimer.
|
|
||||||
|
|
||||||
7. Limitation of Liability
|
|
||||||
|
|
||||||
Under no circumstances and under no legal theory, whether tort (including
|
|
||||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
||||||
distributes Covered Software as permitted above, be liable to You for any
|
|
||||||
direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character including, without limitation, damages for lost profits, loss of
|
|
||||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses, even if such party shall have been
|
|
||||||
informed of the possibility of such damages. This limitation of liability
|
|
||||||
shall not apply to liability for death or personal injury resulting from
|
|
||||||
such party's negligence to the extent applicable law prohibits such
|
|
||||||
limitation. Some jurisdictions do not allow the exclusion or limitation of
|
|
||||||
incidental or consequential damages, so this exclusion and limitation may
|
|
||||||
not apply to You.
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the courts
|
|
||||||
of a jurisdiction where the defendant maintains its principal place of
|
|
||||||
business and such litigation shall be governed by laws of that
|
|
||||||
jurisdiction, without reference to its conflict-of-law provisions. Nothing
|
|
||||||
in this Section shall prevent a party's ability to bring cross-claims or
|
|
||||||
counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject
|
|
||||||
matter hereof. If any provision of this License is held to be
|
|
||||||
unenforceable, such provision shall be reformed only to the extent
|
|
||||||
necessary to make it enforceable. Any law or regulation which provides that
|
|
||||||
the language of a contract shall be construed against the drafter shall not
|
|
||||||
be used to construe this License against a Contributor.
|
|
||||||
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version
|
|
||||||
of the License under which You originally received the Covered Software,
|
|
||||||
or under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a
|
|
||||||
modified version of this License if you rename the license and remove
|
|
||||||
any references to the name of the license steward (except to note that
|
|
||||||
such modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
||||||
Licenses If You choose to distribute Source Code Form that is
|
|
||||||
Incompatible With Secondary Licenses under the terms of this version of
|
|
||||||
the License, the notice described in Exhibit B of this License must be
|
|
||||||
attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
|
|
||||||
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
|
|
||||||
http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular file,
|
|
||||||
then You may include the notice in a location (such as a LICENSE file in a
|
|
||||||
relevant directory) where a recipient would be likely to look for such a
|
|
||||||
notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
||||||
|
|
||||||
This Source Code Form is "Incompatible
|
|
||||||
With Secondary Licenses", as defined by
|
|
||||||
the Mozilla Public License, v. 2.0.
|
|
||||||
|
|
30
vendor/github.com/hashicorp/go-cleanhttp/README.md
generated
vendored
30
vendor/github.com/hashicorp/go-cleanhttp/README.md
generated
vendored
|
@ -1,30 +0,0 @@
|
||||||
# cleanhttp
|
|
||||||
|
|
||||||
Functions for accessing "clean" Go http.Client values
|
|
||||||
|
|
||||||
-------------
|
|
||||||
|
|
||||||
The Go standard library contains a default `http.Client` called
|
|
||||||
`http.DefaultClient`. It is a common idiom in Go code to start with
|
|
||||||
`http.DefaultClient` and tweak it as necessary, and in fact, this is
|
|
||||||
encouraged; from the `http` package documentation:
|
|
||||||
|
|
||||||
> The Client's Transport typically has internal state (cached TCP connections),
|
|
||||||
so Clients should be reused instead of created as needed. Clients are safe for
|
|
||||||
concurrent use by multiple goroutines.
|
|
||||||
|
|
||||||
Unfortunately, this is a shared value, and it is not uncommon for libraries to
|
|
||||||
assume that they are free to modify it at will. With enough dependencies, it
|
|
||||||
can be very easy to encounter strange problems and race conditions due to
|
|
||||||
manipulation of this shared value across libraries and goroutines (clients are
|
|
||||||
safe for concurrent use, but writing values to the client struct itself is not
|
|
||||||
protected).
|
|
||||||
|
|
||||||
Making things worse is the fact that a bare `http.Client` will use a default
|
|
||||||
`http.Transport` called `http.DefaultTransport`, which is another global value
|
|
||||||
that behaves the same way. So it is not simply enough to replace
|
|
||||||
`http.DefaultClient` with `&http.Client{}`.
|
|
||||||
|
|
||||||
This repository provides some simple functions to get a "clean" `http.Client`
|
|
||||||
-- one that uses the same default values as the Go standard library, but
|
|
||||||
returns a client that does not share any state with other clients.
|
|
57
vendor/github.com/hashicorp/go-cleanhttp/cleanhttp.go
generated
vendored
57
vendor/github.com/hashicorp/go-cleanhttp/cleanhttp.go
generated
vendored
|
@ -1,57 +0,0 @@
|
||||||
package cleanhttp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net"
|
|
||||||
"net/http"
|
|
||||||
"runtime"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultTransport returns a new http.Transport with similar default values to
|
|
||||||
// http.DefaultTransport, but with idle connections and keepalives disabled.
|
|
||||||
func DefaultTransport() *http.Transport {
|
|
||||||
transport := DefaultPooledTransport()
|
|
||||||
transport.DisableKeepAlives = true
|
|
||||||
transport.MaxIdleConnsPerHost = -1
|
|
||||||
return transport
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultPooledTransport returns a new http.Transport with similar default
|
|
||||||
// values to http.DefaultTransport. Do not use this for transient transports as
|
|
||||||
// it can leak file descriptors over time. Only use this for transports that
|
|
||||||
// will be re-used for the same host(s).
|
|
||||||
func DefaultPooledTransport() *http.Transport {
|
|
||||||
transport := &http.Transport{
|
|
||||||
Proxy: http.ProxyFromEnvironment,
|
|
||||||
DialContext: (&net.Dialer{
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
KeepAlive: 30 * time.Second,
|
|
||||||
DualStack: true,
|
|
||||||
}).DialContext,
|
|
||||||
MaxIdleConns: 100,
|
|
||||||
IdleConnTimeout: 90 * time.Second,
|
|
||||||
TLSHandshakeTimeout: 10 * time.Second,
|
|
||||||
ExpectContinueTimeout: 1 * time.Second,
|
|
||||||
MaxIdleConnsPerHost: runtime.GOMAXPROCS(0) + 1,
|
|
||||||
}
|
|
||||||
return transport
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultClient returns a new http.Client with similar default values to
|
|
||||||
// http.Client, but with a non-shared Transport, idle connections disabled, and
|
|
||||||
// keepalives disabled.
|
|
||||||
func DefaultClient() *http.Client {
|
|
||||||
return &http.Client{
|
|
||||||
Transport: DefaultTransport(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultPooledClient returns a new http.Client with similar default values to
|
|
||||||
// http.Client, but with a shared Transport. Do not use this function for
|
|
||||||
// transient clients as it can leak file descriptors over time. Only use this
|
|
||||||
// for clients that will be re-used for the same host(s).
|
|
||||||
func DefaultPooledClient() *http.Client {
|
|
||||||
return &http.Client{
|
|
||||||
Transport: DefaultPooledTransport(),
|
|
||||||
}
|
|
||||||
}
|
|
20
vendor/github.com/hashicorp/go-cleanhttp/doc.go
generated
vendored
20
vendor/github.com/hashicorp/go-cleanhttp/doc.go
generated
vendored
|
@ -1,20 +0,0 @@
|
||||||
// Package cleanhttp offers convenience utilities for acquiring "clean"
|
|
||||||
// http.Transport and http.Client structs.
|
|
||||||
//
|
|
||||||
// Values set on http.DefaultClient and http.DefaultTransport affect all
|
|
||||||
// callers. This can have detrimental effects, esepcially in TLS contexts,
|
|
||||||
// where client or root certificates set to talk to multiple endpoints can end
|
|
||||||
// up displacing each other, leading to hard-to-debug issues. This package
|
|
||||||
// provides non-shared http.Client and http.Transport structs to ensure that
|
|
||||||
// the configuration will not be overwritten by other parts of the application
|
|
||||||
// or dependencies.
|
|
||||||
//
|
|
||||||
// The DefaultClient and DefaultTransport functions disable idle connections
|
|
||||||
// and keepalives. Without ensuring that idle connections are closed before
|
|
||||||
// garbage collection, short-term clients/transports can leak file descriptors,
|
|
||||||
// eventually leading to "too many open files" errors. If you will be
|
|
||||||
// connecting to the same hosts repeatedly from the same client, you can use
|
|
||||||
// DefaultPooledClient to receive a client that has connection pooling
|
|
||||||
// semantics similar to http.DefaultClient.
|
|
||||||
//
|
|
||||||
package cleanhttp
|
|
1
vendor/github.com/hashicorp/go-cleanhttp/go.mod
generated
vendored
1
vendor/github.com/hashicorp/go-cleanhttp/go.mod
generated
vendored
|
@ -1 +0,0 @@
|
||||||
module github.com/hashicorp/go-cleanhttp
|
|
43
vendor/github.com/hashicorp/go-cleanhttp/handlers.go
generated
vendored
43
vendor/github.com/hashicorp/go-cleanhttp/handlers.go
generated
vendored
|
@ -1,43 +0,0 @@
|
||||||
package cleanhttp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
"unicode"
|
|
||||||
)
|
|
||||||
|
|
||||||
// HandlerInput provides input options to cleanhttp's handlers
|
|
||||||
type HandlerInput struct {
|
|
||||||
ErrStatus int
|
|
||||||
}
|
|
||||||
|
|
||||||
// PrintablePathCheckHandler is a middleware that ensures the request path
|
|
||||||
// contains only printable runes.
|
|
||||||
func PrintablePathCheckHandler(next http.Handler, input *HandlerInput) http.Handler {
|
|
||||||
// Nil-check on input to make it optional
|
|
||||||
if input == nil {
|
|
||||||
input = &HandlerInput{
|
|
||||||
ErrStatus: http.StatusBadRequest,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Default to http.StatusBadRequest on error
|
|
||||||
if input.ErrStatus == 0 {
|
|
||||||
input.ErrStatus = http.StatusBadRequest
|
|
||||||
}
|
|
||||||
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
// Check URL path for non-printable characters
|
|
||||||
idx := strings.IndexFunc(r.URL.Path, func(c rune) bool {
|
|
||||||
return !unicode.IsPrint(c)
|
|
||||||
})
|
|
||||||
|
|
||||||
if idx != -1 {
|
|
||||||
w.WriteHeader(input.ErrStatus)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
return
|
|
||||||
})
|
|
||||||
}
|
|
12
vendor/github.com/hashicorp/go-multierror/.travis.yml
generated
vendored
12
vendor/github.com/hashicorp/go-multierror/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.x
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make test testrace
|
|
353
vendor/github.com/hashicorp/go-multierror/LICENSE
generated
vendored
353
vendor/github.com/hashicorp/go-multierror/LICENSE
generated
vendored
|
@ -1,353 +0,0 @@
|
||||||
Mozilla Public License, version 2.0
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
|
|
||||||
1.1. “Contributor”
|
|
||||||
|
|
||||||
means each individual or legal entity that creates, contributes to the
|
|
||||||
creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. “Contributor Version”
|
|
||||||
|
|
||||||
means the combination of the Contributions of others (if any) used by a
|
|
||||||
Contributor and that particular Contributor’s Contribution.
|
|
||||||
|
|
||||||
1.3. “Contribution”
|
|
||||||
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. “Covered Software”
|
|
||||||
|
|
||||||
means Source Code Form to which the initial Contributor has attached the
|
|
||||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
||||||
Modifications of such Source Code Form, in each case including portions
|
|
||||||
thereof.
|
|
||||||
|
|
||||||
1.5. “Incompatible With Secondary Licenses”
|
|
||||||
means
|
|
||||||
|
|
||||||
a. that the initial Contributor has attached the notice described in
|
|
||||||
Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
b. that the Covered Software was made available under the terms of version
|
|
||||||
1.1 or earlier of the License, but not also under the terms of a
|
|
||||||
Secondary License.
|
|
||||||
|
|
||||||
1.6. “Executable Form”
|
|
||||||
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. “Larger Work”
|
|
||||||
|
|
||||||
means a work that combines Covered Software with other material, in a separate
|
|
||||||
file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. “License”
|
|
||||||
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. “Licensable”
|
|
||||||
|
|
||||||
means having the right to grant, to the maximum extent possible, whether at the
|
|
||||||
time of the initial grant or subsequently, any and all of the rights conveyed by
|
|
||||||
this License.
|
|
||||||
|
|
||||||
1.10. “Modifications”
|
|
||||||
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
a. any file in Source Code Form that results from an addition to, deletion
|
|
||||||
from, or modification of the contents of Covered Software; or
|
|
||||||
|
|
||||||
b. any new file in Source Code Form that contains any Covered Software.
|
|
||||||
|
|
||||||
1.11. “Patent Claims” of a Contributor
|
|
||||||
|
|
||||||
means any patent claim(s), including without limitation, method, process,
|
|
||||||
and apparatus claims, in any patent Licensable by such Contributor that
|
|
||||||
would be infringed, but for the grant of the License, by the making,
|
|
||||||
using, selling, offering for sale, having made, import, or transfer of
|
|
||||||
either its Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
1.12. “Secondary License”
|
|
||||||
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
||||||
General Public License, Version 2.1, the GNU Affero General Public
|
|
||||||
License, Version 3.0, or any later versions of those licenses.
|
|
||||||
|
|
||||||
1.13. “Source Code Form”
|
|
||||||
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. “You” (or “Your”)
|
|
||||||
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, “You” includes any entity that controls, is
|
|
||||||
controlled by, or is under common control with You. For purposes of this
|
|
||||||
definition, “control” means (a) the power, direct or indirect, to cause
|
|
||||||
the direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
||||||
outstanding shares or beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
a. under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or as
|
|
||||||
part of a Larger Work; and
|
|
||||||
|
|
||||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
||||||
sale, have made, import, and otherwise transfer either its Contributions
|
|
||||||
or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution become
|
|
||||||
effective for each Contribution on the date the Contributor first distributes
|
|
||||||
such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under this
|
|
||||||
License. No additional rights or licenses will be implied from the distribution
|
|
||||||
or licensing of Covered Software under this License. Notwithstanding Section
|
|
||||||
2.1(b) above, no patent license is granted by a Contributor:
|
|
||||||
|
|
||||||
a. for any code that a Contributor has removed from Covered Software; or
|
|
||||||
|
|
||||||
b. for infringements caused by: (i) Your and any other third party’s
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
c. under Patent Claims infringed by Covered Software in the absence of its
|
|
||||||
Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks, or
|
|
||||||
logos of any Contributor (except as may be necessary to comply with the
|
|
||||||
notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this License
|
|
||||||
(see Section 10.2) or under the terms of a Secondary License (if permitted
|
|
||||||
under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its Contributions
|
|
||||||
are its original creation(s) or it has sufficient rights to grant the
|
|
||||||
rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under applicable
|
|
||||||
copyright doctrines of fair use, fair dealing, or other equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
||||||
Section 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under the
|
|
||||||
terms of this License. You must inform recipients that the Source Code Form
|
|
||||||
of the Covered Software is governed by the terms of this License, and how
|
|
||||||
they can obtain a copy of this License. You may not attempt to alter or
|
|
||||||
restrict the recipients’ rights in the Source Code Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
a. such Covered Software must also be made available in Source Code Form,
|
|
||||||
as described in Section 3.1, and You must inform recipients of the
|
|
||||||
Executable Form how they can obtain a copy of such Source Code Form by
|
|
||||||
reasonable means in a timely manner, at a charge no more than the cost
|
|
||||||
of distribution to the recipient; and
|
|
||||||
|
|
||||||
b. You may distribute such Executable Form under the terms of this License,
|
|
||||||
or sublicense it under different terms, provided that the license for
|
|
||||||
the Executable Form does not attempt to limit or alter the recipients’
|
|
||||||
rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for the
|
|
||||||
Covered Software. If the Larger Work is a combination of Covered Software
|
|
||||||
with a work governed by one or more Secondary Licenses, and the Covered
|
|
||||||
Software is not Incompatible With Secondary Licenses, this License permits
|
|
||||||
You to additionally distribute such Covered Software under the terms of
|
|
||||||
such Secondary License(s), so that the recipient of the Larger Work may, at
|
|
||||||
their option, further distribute the Covered Software under the terms of
|
|
||||||
either this License or such Secondary License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices (including
|
|
||||||
copyright notices, patent notices, disclaimers of warranty, or limitations
|
|
||||||
of liability) contained within the Source Code Form of the Covered
|
|
||||||
Software, except that You may alter any license notices to the extent
|
|
||||||
required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on behalf
|
|
||||||
of any Contributor. You must make it absolutely clear that any such
|
|
||||||
warranty, support, indemnity, or liability obligation is offered by You
|
|
||||||
alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this License
|
|
||||||
with respect to some or all of the Covered Software due to statute, judicial
|
|
||||||
order, or regulation then You must: (a) comply with the terms of this License
|
|
||||||
to the maximum extent possible; and (b) describe the limitations and the code
|
|
||||||
they affect. Such description must be placed in a text file included with all
|
|
||||||
distributions of the Covered Software under this License. Except to the
|
|
||||||
extent prohibited by statute or regulation, such description must be
|
|
||||||
sufficiently detailed for a recipient of ordinary skill to be able to
|
|
||||||
understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically if You
|
|
||||||
fail to comply with any of its terms. However, if You become compliant,
|
|
||||||
then the rights granted under this License from a particular Contributor
|
|
||||||
are reinstated (a) provisionally, unless and until such Contributor
|
|
||||||
explicitly and finally terminates Your grants, and (b) on an ongoing basis,
|
|
||||||
if such Contributor fails to notify You of the non-compliance by some
|
|
||||||
reasonable means prior to 60 days after You have come back into compliance.
|
|
||||||
Moreover, Your grants from a particular Contributor are reinstated on an
|
|
||||||
ongoing basis if such Contributor notifies You of the non-compliance by
|
|
||||||
some reasonable means, this is the first time You have received notice of
|
|
||||||
non-compliance with this License from such Contributor, and You become
|
|
||||||
compliant prior to 30 days after Your receipt of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions, counter-claims,
|
|
||||||
and cross-claims) alleging that a Contributor Version directly or
|
|
||||||
indirectly infringes any patent, then the rights granted to You by any and
|
|
||||||
all Contributors for the Covered Software under Section 2.1 of this License
|
|
||||||
shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
||||||
license agreements (excluding distributors and resellers) which have been
|
|
||||||
validly granted by You or Your distributors under this License prior to
|
|
||||||
termination shall survive termination.
|
|
||||||
|
|
||||||
6. Disclaimer of Warranty
|
|
||||||
|
|
||||||
Covered Software is provided under this License on an “as is” basis, without
|
|
||||||
warranty of any kind, either expressed, implied, or statutory, including,
|
|
||||||
without limitation, warranties that the Covered Software is free of defects,
|
|
||||||
merchantable, fit for a particular purpose or non-infringing. The entire
|
|
||||||
risk as to the quality and performance of the Covered Software is with You.
|
|
||||||
Should any Covered Software prove defective in any respect, You (not any
|
|
||||||
Contributor) assume the cost of any necessary servicing, repair, or
|
|
||||||
correction. This disclaimer of warranty constitutes an essential part of this
|
|
||||||
License. No use of any Covered Software is authorized under this License
|
|
||||||
except under this disclaimer.
|
|
||||||
|
|
||||||
7. Limitation of Liability
|
|
||||||
|
|
||||||
Under no circumstances and under no legal theory, whether tort (including
|
|
||||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
||||||
distributes Covered Software as permitted above, be liable to You for any
|
|
||||||
direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character including, without limitation, damages for lost profits, loss of
|
|
||||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses, even if such party shall have been
|
|
||||||
informed of the possibility of such damages. This limitation of liability
|
|
||||||
shall not apply to liability for death or personal injury resulting from such
|
|
||||||
party’s negligence to the extent applicable law prohibits such limitation.
|
|
||||||
Some jurisdictions do not allow the exclusion or limitation of incidental or
|
|
||||||
consequential damages, so this exclusion and limitation may not apply to You.
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the courts of
|
|
||||||
a jurisdiction where the defendant maintains its principal place of business
|
|
||||||
and such litigation shall be governed by laws of that jurisdiction, without
|
|
||||||
reference to its conflict-of-law provisions. Nothing in this Section shall
|
|
||||||
prevent a party’s ability to bring cross-claims or counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject matter
|
|
||||||
hereof. If any provision of this License is held to be unenforceable, such
|
|
||||||
provision shall be reformed only to the extent necessary to make it
|
|
||||||
enforceable. Any law or regulation which provides that the language of a
|
|
||||||
contract shall be construed against the drafter shall not be used to construe
|
|
||||||
this License against a Contributor.
|
|
||||||
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version of
|
|
||||||
the License under which You originally received the Covered Software, or
|
|
||||||
under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a modified
|
|
||||||
version of this License if you rename the license and remove any
|
|
||||||
references to the name of the license steward (except to note that such
|
|
||||||
modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
|
|
||||||
If You choose to distribute Source Code Form that is Incompatible With
|
|
||||||
Secondary Licenses under the terms of this version of the License, the
|
|
||||||
notice described in Exhibit B of this License must be attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
|
|
||||||
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
|
|
||||||
http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular file, then
|
|
||||||
You may include the notice in a location (such as a LICENSE file in a relevant
|
|
||||||
directory) where a recipient would be likely to look for such a notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - “Incompatible With Secondary Licenses” Notice
|
|
||||||
|
|
||||||
This Source Code Form is “Incompatible
|
|
||||||
With Secondary Licenses”, as defined by
|
|
||||||
the Mozilla Public License, v. 2.0.
|
|
31
vendor/github.com/hashicorp/go-multierror/Makefile
generated
vendored
31
vendor/github.com/hashicorp/go-multierror/Makefile
generated
vendored
|
@ -1,31 +0,0 @@
|
||||||
TEST?=./...
|
|
||||||
|
|
||||||
default: test
|
|
||||||
|
|
||||||
# test runs the test suite and vets the code.
|
|
||||||
test: generate
|
|
||||||
@echo "==> Running tests..."
|
|
||||||
@go list $(TEST) \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go test -timeout=60s -parallel=10 ${TESTARGS}
|
|
||||||
|
|
||||||
# testrace runs the race checker
|
|
||||||
testrace: generate
|
|
||||||
@echo "==> Running tests (race)..."
|
|
||||||
@go list $(TEST) \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go test -timeout=60s -race ${TESTARGS}
|
|
||||||
|
|
||||||
# updatedeps installs all the dependencies needed to run and build.
|
|
||||||
updatedeps:
|
|
||||||
@sh -c "'${CURDIR}/scripts/deps.sh' '${NAME}'"
|
|
||||||
|
|
||||||
# generate runs `go generate` to build the dynamically generated source files.
|
|
||||||
generate:
|
|
||||||
@echo "==> Generating..."
|
|
||||||
@find . -type f -name '.DS_Store' -delete
|
|
||||||
@go list ./... \
|
|
||||||
| grep -v "/vendor/" \
|
|
||||||
| xargs -n1 go generate
|
|
||||||
|
|
||||||
.PHONY: default test testrace updatedeps generate
|
|
97
vendor/github.com/hashicorp/go-multierror/README.md
generated
vendored
97
vendor/github.com/hashicorp/go-multierror/README.md
generated
vendored
|
@ -1,97 +0,0 @@
|
||||||
# go-multierror
|
|
||||||
|
|
||||||
[![Build Status](http://img.shields.io/travis/hashicorp/go-multierror.svg?style=flat-square)][travis]
|
|
||||||
[![Go Documentation](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][godocs]
|
|
||||||
|
|
||||||
[travis]: https://travis-ci.org/hashicorp/go-multierror
|
|
||||||
[godocs]: https://godoc.org/github.com/hashicorp/go-multierror
|
|
||||||
|
|
||||||
`go-multierror` is a package for Go that provides a mechanism for
|
|
||||||
representing a list of `error` values as a single `error`.
|
|
||||||
|
|
||||||
This allows a function in Go to return an `error` that might actually
|
|
||||||
be a list of errors. If the caller knows this, they can unwrap the
|
|
||||||
list and access the errors. If the caller doesn't know, the error
|
|
||||||
formats to a nice human-readable format.
|
|
||||||
|
|
||||||
`go-multierror` implements the
|
|
||||||
[errwrap](https://github.com/hashicorp/errwrap) interface so that it can
|
|
||||||
be used with that library, as well.
|
|
||||||
|
|
||||||
## Installation and Docs
|
|
||||||
|
|
||||||
Install using `go get github.com/hashicorp/go-multierror`.
|
|
||||||
|
|
||||||
Full documentation is available at
|
|
||||||
http://godoc.org/github.com/hashicorp/go-multierror
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
go-multierror is easy to use and purposely built to be unobtrusive in
|
|
||||||
existing Go applications/libraries that may not be aware of it.
|
|
||||||
|
|
||||||
**Building a list of errors**
|
|
||||||
|
|
||||||
The `Append` function is used to create a list of errors. This function
|
|
||||||
behaves a lot like the Go built-in `append` function: it doesn't matter
|
|
||||||
if the first argument is nil, a `multierror.Error`, or any other `error`,
|
|
||||||
the function behaves as you would expect.
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result error
|
|
||||||
|
|
||||||
if err := step1(); err != nil {
|
|
||||||
result = multierror.Append(result, err)
|
|
||||||
}
|
|
||||||
if err := step2(); err != nil {
|
|
||||||
result = multierror.Append(result, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return result
|
|
||||||
```
|
|
||||||
|
|
||||||
**Customizing the formatting of the errors**
|
|
||||||
|
|
||||||
By specifying a custom `ErrorFormat`, you can customize the format
|
|
||||||
of the `Error() string` function:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result *multierror.Error
|
|
||||||
|
|
||||||
// ... accumulate errors here, maybe using Append
|
|
||||||
|
|
||||||
if result != nil {
|
|
||||||
result.ErrorFormat = func([]error) string {
|
|
||||||
return "errors!"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Accessing the list of errors**
|
|
||||||
|
|
||||||
`multierror.Error` implements `error` so if the caller doesn't know about
|
|
||||||
multierror, it will work just fine. But if you're aware a multierror might
|
|
||||||
be returned, you can use type switches to access the list of errors:
|
|
||||||
|
|
||||||
```go
|
|
||||||
if err := something(); err != nil {
|
|
||||||
if merr, ok := err.(*multierror.Error); ok {
|
|
||||||
// Use merr.Errors
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Returning a multierror only if there are errors**
|
|
||||||
|
|
||||||
If you build a `multierror.Error`, you can use the `ErrorOrNil` function
|
|
||||||
to return an `error` implementation only if there are errors to return:
|
|
||||||
|
|
||||||
```go
|
|
||||||
var result *multierror.Error
|
|
||||||
|
|
||||||
// ... accumulate errors here
|
|
||||||
|
|
||||||
// Return the `error` only if errors were added to the multierror, otherwise
|
|
||||||
// return nil since there are no errors.
|
|
||||||
return result.ErrorOrNil()
|
|
||||||
```
|
|
41
vendor/github.com/hashicorp/go-multierror/append.go
generated
vendored
41
vendor/github.com/hashicorp/go-multierror/append.go
generated
vendored
|
@ -1,41 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
// Append is a helper function that will append more errors
|
|
||||||
// onto an Error in order to create a larger multi-error.
|
|
||||||
//
|
|
||||||
// If err is not a multierror.Error, then it will be turned into
|
|
||||||
// one. If any of the errs are multierr.Error, they will be flattened
|
|
||||||
// one level into err.
|
|
||||||
func Append(err error, errs ...error) *Error {
|
|
||||||
switch err := err.(type) {
|
|
||||||
case *Error:
|
|
||||||
// Typed nils can reach here, so initialize if we are nil
|
|
||||||
if err == nil {
|
|
||||||
err = new(Error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Go through each error and flatten
|
|
||||||
for _, e := range errs {
|
|
||||||
switch e := e.(type) {
|
|
||||||
case *Error:
|
|
||||||
if e != nil {
|
|
||||||
err.Errors = append(err.Errors, e.Errors...)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
if e != nil {
|
|
||||||
err.Errors = append(err.Errors, e)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
default:
|
|
||||||
newErrs := make([]error, 0, len(errs)+1)
|
|
||||||
if err != nil {
|
|
||||||
newErrs = append(newErrs, err)
|
|
||||||
}
|
|
||||||
newErrs = append(newErrs, errs...)
|
|
||||||
|
|
||||||
return Append(&Error{}, newErrs...)
|
|
||||||
}
|
|
||||||
}
|
|
26
vendor/github.com/hashicorp/go-multierror/flatten.go
generated
vendored
26
vendor/github.com/hashicorp/go-multierror/flatten.go
generated
vendored
|
@ -1,26 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
// Flatten flattens the given error, merging any *Errors together into
|
|
||||||
// a single *Error.
|
|
||||||
func Flatten(err error) error {
|
|
||||||
// If it isn't an *Error, just return the error as-is
|
|
||||||
if _, ok := err.(*Error); !ok {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Otherwise, make the result and flatten away!
|
|
||||||
flatErr := new(Error)
|
|
||||||
flatten(err, flatErr)
|
|
||||||
return flatErr
|
|
||||||
}
|
|
||||||
|
|
||||||
func flatten(err error, flatErr *Error) {
|
|
||||||
switch err := err.(type) {
|
|
||||||
case *Error:
|
|
||||||
for _, e := range err.Errors {
|
|
||||||
flatten(e, flatErr)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
flatErr.Errors = append(flatErr.Errors, err)
|
|
||||||
}
|
|
||||||
}
|
|
27
vendor/github.com/hashicorp/go-multierror/format.go
generated
vendored
27
vendor/github.com/hashicorp/go-multierror/format.go
generated
vendored
|
@ -1,27 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrorFormatFunc is a function callback that is called by Error to
|
|
||||||
// turn the list of errors into a string.
|
|
||||||
type ErrorFormatFunc func([]error) string
|
|
||||||
|
|
||||||
// ListFormatFunc is a basic formatter that outputs the number of errors
|
|
||||||
// that occurred along with a bullet point list of the errors.
|
|
||||||
func ListFormatFunc(es []error) string {
|
|
||||||
if len(es) == 1 {
|
|
||||||
return fmt.Sprintf("1 error occurred:\n\t* %s\n\n", es[0])
|
|
||||||
}
|
|
||||||
|
|
||||||
points := make([]string, len(es))
|
|
||||||
for i, err := range es {
|
|
||||||
points[i] = fmt.Sprintf("* %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf(
|
|
||||||
"%d errors occurred:\n\t%s\n\n",
|
|
||||||
len(es), strings.Join(points, "\n\t"))
|
|
||||||
}
|
|
3
vendor/github.com/hashicorp/go-multierror/go.mod
generated
vendored
3
vendor/github.com/hashicorp/go-multierror/go.mod
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
module github.com/hashicorp/go-multierror
|
|
||||||
|
|
||||||
require github.com/hashicorp/errwrap v1.0.0
|
|
4
vendor/github.com/hashicorp/go-multierror/go.sum
generated
vendored
4
vendor/github.com/hashicorp/go-multierror/go.sum
generated
vendored
|
@ -1,4 +0,0 @@
|
||||||
github.com/hashicorp/errwrap v0.0.0-20141028054710-7554cd9344ce h1:prjrVgOk2Yg6w+PflHoszQNLTUh4kaByUcEWM/9uin4=
|
|
||||||
github.com/hashicorp/errwrap v0.0.0-20141028054710-7554cd9344ce/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
|
|
||||||
github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA=
|
|
||||||
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
|
|
51
vendor/github.com/hashicorp/go-multierror/multierror.go
generated
vendored
51
vendor/github.com/hashicorp/go-multierror/multierror.go
generated
vendored
|
@ -1,51 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Error is an error type to track multiple errors. This is used to
|
|
||||||
// accumulate errors in cases and return them as a single "error".
|
|
||||||
type Error struct {
|
|
||||||
Errors []error
|
|
||||||
ErrorFormat ErrorFormatFunc
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Error) Error() string {
|
|
||||||
fn := e.ErrorFormat
|
|
||||||
if fn == nil {
|
|
||||||
fn = ListFormatFunc
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(e.Errors)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ErrorOrNil returns an error interface if this Error represents
|
|
||||||
// a list of errors, or returns nil if the list of errors is empty. This
|
|
||||||
// function is useful at the end of accumulation to make sure that the value
|
|
||||||
// returned represents the existence of errors.
|
|
||||||
func (e *Error) ErrorOrNil() error {
|
|
||||||
if e == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if len(e.Errors) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Error) GoString() string {
|
|
||||||
return fmt.Sprintf("*%#v", *e)
|
|
||||||
}
|
|
||||||
|
|
||||||
// WrappedErrors returns the list of errors that this Error is wrapping.
|
|
||||||
// It is an implementation of the errwrap.Wrapper interface so that
|
|
||||||
// multierror.Error can be used with that library.
|
|
||||||
//
|
|
||||||
// This method is not safe to be called concurrently and is no different
|
|
||||||
// than accessing the Errors field directly. It is implemented only to
|
|
||||||
// satisfy the errwrap.Wrapper interface.
|
|
||||||
func (e *Error) WrappedErrors() []error {
|
|
||||||
return e.Errors
|
|
||||||
}
|
|
37
vendor/github.com/hashicorp/go-multierror/prefix.go
generated
vendored
37
vendor/github.com/hashicorp/go-multierror/prefix.go
generated
vendored
|
@ -1,37 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/hashicorp/errwrap"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Prefix is a helper function that will prefix some text
|
|
||||||
// to the given error. If the error is a multierror.Error, then
|
|
||||||
// it will be prefixed to each wrapped error.
|
|
||||||
//
|
|
||||||
// This is useful to use when appending multiple multierrors
|
|
||||||
// together in order to give better scoping.
|
|
||||||
func Prefix(err error, prefix string) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
format := fmt.Sprintf("%s {{err}}", prefix)
|
|
||||||
switch err := err.(type) {
|
|
||||||
case *Error:
|
|
||||||
// Typed nils can reach here, so initialize if we are nil
|
|
||||||
if err == nil {
|
|
||||||
err = new(Error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wrap each of the errors
|
|
||||||
for i, e := range err.Errors {
|
|
||||||
err.Errors[i] = errwrap.Wrapf(format, e)
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
default:
|
|
||||||
return errwrap.Wrapf(format, err)
|
|
||||||
}
|
|
||||||
}
|
|
16
vendor/github.com/hashicorp/go-multierror/sort.go
generated
vendored
16
vendor/github.com/hashicorp/go-multierror/sort.go
generated
vendored
|
@ -1,16 +0,0 @@
|
||||||
package multierror
|
|
||||||
|
|
||||||
// Len implements sort.Interface function for length
|
|
||||||
func (err Error) Len() int {
|
|
||||||
return len(err.Errors)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap implements sort.Interface function for swapping elements
|
|
||||||
func (err Error) Swap(i, j int) {
|
|
||||||
err.Errors[i], err.Errors[j] = err.Errors[j], err.Errors[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Less implements sort.Interface function for determining order
|
|
||||||
func (err Error) Less(i, j int) bool {
|
|
||||||
return err.Errors[i].Error() < err.Errors[j].Error()
|
|
||||||
}
|
|
3
vendor/github.com/hashicorp/go-retryablehttp/.gitignore
generated
vendored
3
vendor/github.com/hashicorp/go-retryablehttp/.gitignore
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
.idea/
|
|
||||||
*.iml
|
|
||||||
*.test
|
|
12
vendor/github.com/hashicorp/go-retryablehttp/.travis.yml
generated
vendored
12
vendor/github.com/hashicorp/go-retryablehttp/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8.1
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make updatedeps test
|
|
363
vendor/github.com/hashicorp/go-retryablehttp/LICENSE
generated
vendored
363
vendor/github.com/hashicorp/go-retryablehttp/LICENSE
generated
vendored
|
@ -1,363 +0,0 @@
|
||||||
Mozilla Public License, version 2.0
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
|
|
||||||
1.1. "Contributor"
|
|
||||||
|
|
||||||
means each individual or legal entity that creates, contributes to the
|
|
||||||
creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. "Contributor Version"
|
|
||||||
|
|
||||||
means the combination of the Contributions of others (if any) used by a
|
|
||||||
Contributor and that particular Contributor's Contribution.
|
|
||||||
|
|
||||||
1.3. "Contribution"
|
|
||||||
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. "Covered Software"
|
|
||||||
|
|
||||||
means Source Code Form to which the initial Contributor has attached the
|
|
||||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
||||||
Modifications of such Source Code Form, in each case including portions
|
|
||||||
thereof.
|
|
||||||
|
|
||||||
1.5. "Incompatible With Secondary Licenses"
|
|
||||||
means
|
|
||||||
|
|
||||||
a. that the initial Contributor has attached the notice described in
|
|
||||||
Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
b. that the Covered Software was made available under the terms of
|
|
||||||
version 1.1 or earlier of the License, but not also under the terms of
|
|
||||||
a Secondary License.
|
|
||||||
|
|
||||||
1.6. "Executable Form"
|
|
||||||
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. "Larger Work"
|
|
||||||
|
|
||||||
means a work that combines Covered Software with other material, in a
|
|
||||||
separate file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. "License"
|
|
||||||
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. "Licensable"
|
|
||||||
|
|
||||||
means having the right to grant, to the maximum extent possible, whether
|
|
||||||
at the time of the initial grant or subsequently, any and all of the
|
|
||||||
rights conveyed by this License.
|
|
||||||
|
|
||||||
1.10. "Modifications"
|
|
||||||
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
a. any file in Source Code Form that results from an addition to,
|
|
||||||
deletion from, or modification of the contents of Covered Software; or
|
|
||||||
|
|
||||||
b. any new file in Source Code Form that contains any Covered Software.
|
|
||||||
|
|
||||||
1.11. "Patent Claims" of a Contributor
|
|
||||||
|
|
||||||
means any patent claim(s), including without limitation, method,
|
|
||||||
process, and apparatus claims, in any patent Licensable by such
|
|
||||||
Contributor that would be infringed, but for the grant of the License,
|
|
||||||
by the making, using, selling, offering for sale, having made, import,
|
|
||||||
or transfer of either its Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
1.12. "Secondary License"
|
|
||||||
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
||||||
General Public License, Version 2.1, the GNU Affero General Public
|
|
||||||
License, Version 3.0, or any later versions of those licenses.
|
|
||||||
|
|
||||||
1.13. "Source Code Form"
|
|
||||||
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. "You" (or "Your")
|
|
||||||
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, "You" includes any entity that controls, is
|
|
||||||
controlled by, or is under common control with You. For purposes of this
|
|
||||||
definition, "control" means (a) the power, direct or indirect, to cause
|
|
||||||
the direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
||||||
outstanding shares or beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
a. under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or
|
|
||||||
as part of a Larger Work; and
|
|
||||||
|
|
||||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
||||||
sale, have made, import, and otherwise transfer either its
|
|
||||||
Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution
|
|
||||||
become effective for each Contribution on the date the Contributor first
|
|
||||||
distributes such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under
|
|
||||||
this License. No additional rights or licenses will be implied from the
|
|
||||||
distribution or licensing of Covered Software under this License.
|
|
||||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
||||||
Contributor:
|
|
||||||
|
|
||||||
a. for any code that a Contributor has removed from Covered Software; or
|
|
||||||
|
|
||||||
b. for infringements caused by: (i) Your and any other third party's
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
c. under Patent Claims infringed by Covered Software in the absence of
|
|
||||||
its Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks,
|
|
||||||
or logos of any Contributor (except as may be necessary to comply with
|
|
||||||
the notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this
|
|
||||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
||||||
permitted under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its
|
|
||||||
Contributions are its original creation(s) or it has sufficient rights to
|
|
||||||
grant the rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under
|
|
||||||
applicable copyright doctrines of fair use, fair dealing, or other
|
|
||||||
equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
||||||
Section 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under
|
|
||||||
the terms of this License. You must inform recipients that the Source
|
|
||||||
Code Form of the Covered Software is governed by the terms of this
|
|
||||||
License, and how they can obtain a copy of this License. You may not
|
|
||||||
attempt to alter or restrict the recipients' rights in the Source Code
|
|
||||||
Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
a. such Covered Software must also be made available in Source Code Form,
|
|
||||||
as described in Section 3.1, and You must inform recipients of the
|
|
||||||
Executable Form how they can obtain a copy of such Source Code Form by
|
|
||||||
reasonable means in a timely manner, at a charge no more than the cost
|
|
||||||
of distribution to the recipient; and
|
|
||||||
|
|
||||||
b. You may distribute such Executable Form under the terms of this
|
|
||||||
License, or sublicense it under different terms, provided that the
|
|
||||||
license for the Executable Form does not attempt to limit or alter the
|
|
||||||
recipients' rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for
|
|
||||||
the Covered Software. If the Larger Work is a combination of Covered
|
|
||||||
Software with a work governed by one or more Secondary Licenses, and the
|
|
||||||
Covered Software is not Incompatible With Secondary Licenses, this
|
|
||||||
License permits You to additionally distribute such Covered Software
|
|
||||||
under the terms of such Secondary License(s), so that the recipient of
|
|
||||||
the Larger Work may, at their option, further distribute the Covered
|
|
||||||
Software under the terms of either this License or such Secondary
|
|
||||||
License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices
|
|
||||||
(including copyright notices, patent notices, disclaimers of warranty, or
|
|
||||||
limitations of liability) contained within the Source Code Form of the
|
|
||||||
Covered Software, except that You may alter any license notices to the
|
|
||||||
extent required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on
|
|
||||||
behalf of any Contributor. You must make it absolutely clear that any
|
|
||||||
such warranty, support, indemnity, or liability obligation is offered by
|
|
||||||
You alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this License
|
|
||||||
with respect to some or all of the Covered Software due to statute,
|
|
||||||
judicial order, or regulation then You must: (a) comply with the terms of
|
|
||||||
this License to the maximum extent possible; and (b) describe the
|
|
||||||
limitations and the code they affect. Such description must be placed in a
|
|
||||||
text file included with all distributions of the Covered Software under
|
|
||||||
this License. Except to the extent prohibited by statute or regulation,
|
|
||||||
such description must be sufficiently detailed for a recipient of ordinary
|
|
||||||
skill to be able to understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically if You
|
|
||||||
fail to comply with any of its terms. However, if You become compliant,
|
|
||||||
then the rights granted under this License from a particular Contributor
|
|
||||||
are reinstated (a) provisionally, unless and until such Contributor
|
|
||||||
explicitly and finally terminates Your grants, and (b) on an ongoing
|
|
||||||
basis, if such Contributor fails to notify You of the non-compliance by
|
|
||||||
some reasonable means prior to 60 days after You have come back into
|
|
||||||
compliance. Moreover, Your grants from a particular Contributor are
|
|
||||||
reinstated on an ongoing basis if such Contributor notifies You of the
|
|
||||||
non-compliance by some reasonable means, this is the first time You have
|
|
||||||
received notice of non-compliance with this License from such
|
|
||||||
Contributor, and You become compliant prior to 30 days after Your receipt
|
|
||||||
of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions,
|
|
||||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
||||||
directly or indirectly infringes any patent, then the rights granted to
|
|
||||||
You by any and all Contributors for the Covered Software under Section
|
|
||||||
2.1 of this License shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
||||||
license agreements (excluding distributors and resellers) which have been
|
|
||||||
validly granted by You or Your distributors under this License prior to
|
|
||||||
termination shall survive termination.
|
|
||||||
|
|
||||||
6. Disclaimer of Warranty
|
|
||||||
|
|
||||||
Covered Software is provided under this License on an "as is" basis,
|
|
||||||
without warranty of any kind, either expressed, implied, or statutory,
|
|
||||||
including, without limitation, warranties that the Covered Software is free
|
|
||||||
of defects, merchantable, fit for a particular purpose or non-infringing.
|
|
||||||
The entire risk as to the quality and performance of the Covered Software
|
|
||||||
is with You. Should any Covered Software prove defective in any respect,
|
|
||||||
You (not any Contributor) assume the cost of any necessary servicing,
|
|
||||||
repair, or correction. This disclaimer of warranty constitutes an essential
|
|
||||||
part of this License. No use of any Covered Software is authorized under
|
|
||||||
this License except under this disclaimer.
|
|
||||||
|
|
||||||
7. Limitation of Liability
|
|
||||||
|
|
||||||
Under no circumstances and under no legal theory, whether tort (including
|
|
||||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
||||||
distributes Covered Software as permitted above, be liable to You for any
|
|
||||||
direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character including, without limitation, damages for lost profits, loss of
|
|
||||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses, even if such party shall have been
|
|
||||||
informed of the possibility of such damages. This limitation of liability
|
|
||||||
shall not apply to liability for death or personal injury resulting from
|
|
||||||
such party's negligence to the extent applicable law prohibits such
|
|
||||||
limitation. Some jurisdictions do not allow the exclusion or limitation of
|
|
||||||
incidental or consequential damages, so this exclusion and limitation may
|
|
||||||
not apply to You.
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the courts
|
|
||||||
of a jurisdiction where the defendant maintains its principal place of
|
|
||||||
business and such litigation shall be governed by laws of that
|
|
||||||
jurisdiction, without reference to its conflict-of-law provisions. Nothing
|
|
||||||
in this Section shall prevent a party's ability to bring cross-claims or
|
|
||||||
counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject
|
|
||||||
matter hereof. If any provision of this License is held to be
|
|
||||||
unenforceable, such provision shall be reformed only to the extent
|
|
||||||
necessary to make it enforceable. Any law or regulation which provides that
|
|
||||||
the language of a contract shall be construed against the drafter shall not
|
|
||||||
be used to construe this License against a Contributor.
|
|
||||||
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version
|
|
||||||
of the License under which You originally received the Covered Software,
|
|
||||||
or under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a
|
|
||||||
modified version of this License if you rename the license and remove
|
|
||||||
any references to the name of the license steward (except to note that
|
|
||||||
such modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
||||||
Licenses If You choose to distribute Source Code Form that is
|
|
||||||
Incompatible With Secondary Licenses under the terms of this version of
|
|
||||||
the License, the notice described in Exhibit B of this License must be
|
|
||||||
attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
|
|
||||||
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
|
|
||||||
http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular file,
|
|
||||||
then You may include the notice in a location (such as a LICENSE file in a
|
|
||||||
relevant directory) where a recipient would be likely to look for such a
|
|
||||||
notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
||||||
|
|
||||||
This Source Code Form is "Incompatible
|
|
||||||
With Secondary Licenses", as defined by
|
|
||||||
the Mozilla Public License, v. 2.0.
|
|
||||||
|
|
11
vendor/github.com/hashicorp/go-retryablehttp/Makefile
generated
vendored
11
vendor/github.com/hashicorp/go-retryablehttp/Makefile
generated
vendored
|
@ -1,11 +0,0 @@
|
||||||
default: test
|
|
||||||
|
|
||||||
test:
|
|
||||||
go vet ./...
|
|
||||||
go test -race ./...
|
|
||||||
|
|
||||||
updatedeps:
|
|
||||||
go get -f -t -u ./...
|
|
||||||
go get -f -u ./...
|
|
||||||
|
|
||||||
.PHONY: default test updatedeps
|
|
46
vendor/github.com/hashicorp/go-retryablehttp/README.md
generated
vendored
46
vendor/github.com/hashicorp/go-retryablehttp/README.md
generated
vendored
|
@ -1,46 +0,0 @@
|
||||||
go-retryablehttp
|
|
||||||
================
|
|
||||||
|
|
||||||
[![Build Status](http://img.shields.io/travis/hashicorp/go-retryablehttp.svg?style=flat-square)][travis]
|
|
||||||
[![Go Documentation](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)][godocs]
|
|
||||||
|
|
||||||
[travis]: http://travis-ci.org/hashicorp/go-retryablehttp
|
|
||||||
[godocs]: http://godoc.org/github.com/hashicorp/go-retryablehttp
|
|
||||||
|
|
||||||
The `retryablehttp` package provides a familiar HTTP client interface with
|
|
||||||
automatic retries and exponential backoff. It is a thin wrapper over the
|
|
||||||
standard `net/http` client library and exposes nearly the same public API. This
|
|
||||||
makes `retryablehttp` very easy to drop into existing programs.
|
|
||||||
|
|
||||||
`retryablehttp` performs automatic retries under certain conditions. Mainly, if
|
|
||||||
an error is returned by the client (connection errors, etc.), or if a 500-range
|
|
||||||
response code is received (except 501), then a retry is invoked after a wait
|
|
||||||
period. Otherwise, the response is returned and left to the caller to
|
|
||||||
interpret.
|
|
||||||
|
|
||||||
The main difference from `net/http` is that requests which take a request body
|
|
||||||
(POST/PUT et. al) can have the body provided in a number of ways (some more or
|
|
||||||
less efficient) that allow "rewinding" the request body if the initial request
|
|
||||||
fails so that the full request can be attempted again. See the
|
|
||||||
[godoc](http://godoc.org/github.com/hashicorp/go-retryablehttp) for more
|
|
||||||
details.
|
|
||||||
|
|
||||||
Example Use
|
|
||||||
===========
|
|
||||||
|
|
||||||
Using this library should look almost identical to what you would do with
|
|
||||||
`net/http`. The most simple example of a GET request is shown below:
|
|
||||||
|
|
||||||
```go
|
|
||||||
resp, err := retryablehttp.Get("/foo")
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The returned response object is an `*http.Response`, the same thing you would
|
|
||||||
usually get from `net/http`. Had the request failed one or more times, the above
|
|
||||||
call would block and retry with exponential backoff.
|
|
||||||
|
|
||||||
For more usage and examples see the
|
|
||||||
[godoc](http://godoc.org/github.com/hashicorp/go-retryablehttp).
|
|
528
vendor/github.com/hashicorp/go-retryablehttp/client.go
generated
vendored
528
vendor/github.com/hashicorp/go-retryablehttp/client.go
generated
vendored
|
@ -1,528 +0,0 @@
|
||||||
// The retryablehttp package provides a familiar HTTP client interface with
|
|
||||||
// automatic retries and exponential backoff. It is a thin wrapper over the
|
|
||||||
// standard net/http client library and exposes nearly the same public API.
|
|
||||||
// This makes retryablehttp very easy to drop into existing programs.
|
|
||||||
//
|
|
||||||
// retryablehttp performs automatic retries under certain conditions. Mainly, if
|
|
||||||
// an error is returned by the client (connection errors etc), or if a 500-range
|
|
||||||
// response is received, then a retry is invoked. Otherwise, the response is
|
|
||||||
// returned and left to the caller to interpret.
|
|
||||||
//
|
|
||||||
// Requests which take a request body should provide a non-nil function
|
|
||||||
// parameter. The best choice is to provide either a function satisfying
|
|
||||||
// ReaderFunc which provides multiple io.Readers in an efficient manner, a
|
|
||||||
// *bytes.Buffer (the underlying raw byte slice will be used) or a raw byte
|
|
||||||
// slice. As it is a reference type, and we will wrap it as needed by readers,
|
|
||||||
// we can efficiently re-use the request body without needing to copy it. If an
|
|
||||||
// io.Reader (such as a *bytes.Reader) is provided, the full body will be read
|
|
||||||
// prior to the first request, and will be efficiently re-used for any retries.
|
|
||||||
// ReadSeeker can be used, but some users have observed occasional data races
|
|
||||||
// between the net/http library and the Seek functionality of some
|
|
||||||
// implementations of ReadSeeker, so should be avoided if possible.
|
|
||||||
package retryablehttp
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"math"
|
|
||||||
"math/rand"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
cleanhttp "github.com/hashicorp/go-cleanhttp"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// Default retry configuration
|
|
||||||
defaultRetryWaitMin = 1 * time.Second
|
|
||||||
defaultRetryWaitMax = 30 * time.Second
|
|
||||||
defaultRetryMax = 4
|
|
||||||
|
|
||||||
// defaultClient is used for performing requests without explicitly making
|
|
||||||
// a new client. It is purposely private to avoid modifications.
|
|
||||||
defaultClient = NewClient()
|
|
||||||
|
|
||||||
// We need to consume response bodies to maintain http connections, but
|
|
||||||
// limit the size we consume to respReadLimit.
|
|
||||||
respReadLimit = int64(4096)
|
|
||||||
)
|
|
||||||
|
|
||||||
// ReaderFunc is the type of function that can be given natively to NewRequest
|
|
||||||
type ReaderFunc func() (io.Reader, error)
|
|
||||||
|
|
||||||
// LenReader is an interface implemented by many in-memory io.Reader's. Used
|
|
||||||
// for automatically sending the right Content-Length header when possible.
|
|
||||||
type LenReader interface {
|
|
||||||
Len() int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Request wraps the metadata needed to create HTTP requests.
|
|
||||||
type Request struct {
|
|
||||||
// body is a seekable reader over the request body payload. This is
|
|
||||||
// used to rewind the request data in between retries.
|
|
||||||
body ReaderFunc
|
|
||||||
|
|
||||||
// Embed an HTTP request directly. This makes a *Request act exactly
|
|
||||||
// like an *http.Request so that all meta methods are supported.
|
|
||||||
*http.Request
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithContext returns wrapped Request with a shallow copy of underlying *http.Request
|
|
||||||
// with its context changed to ctx. The provided ctx must be non-nil.
|
|
||||||
func (r *Request) WithContext(ctx context.Context) *Request {
|
|
||||||
r.Request = r.Request.WithContext(ctx)
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
|
|
||||||
// BodyBytes allows accessing the request body. It is an analogue to
|
|
||||||
// http.Request's Body variable, but it returns a copy of the underlying data
|
|
||||||
// rather than consuming it.
|
|
||||||
//
|
|
||||||
// This function is not thread-safe; do not call it at the same time as another
|
|
||||||
// call, or at the same time this request is being used with Client.Do.
|
|
||||||
func (r *Request) BodyBytes() ([]byte, error) {
|
|
||||||
if r.body == nil {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
body, err := r.body()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
buf := new(bytes.Buffer)
|
|
||||||
_, err = buf.ReadFrom(body)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewRequest creates a new wrapped request.
|
|
||||||
func NewRequest(method, url string, rawBody interface{}) (*Request, error) {
|
|
||||||
var err error
|
|
||||||
var body ReaderFunc
|
|
||||||
var contentLength int64
|
|
||||||
|
|
||||||
if rawBody != nil {
|
|
||||||
switch rawBody.(type) {
|
|
||||||
// If they gave us a function already, great! Use it.
|
|
||||||
case ReaderFunc:
|
|
||||||
body = rawBody.(ReaderFunc)
|
|
||||||
tmp, err := body()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if lr, ok := tmp.(LenReader); ok {
|
|
||||||
contentLength = int64(lr.Len())
|
|
||||||
}
|
|
||||||
if c, ok := tmp.(io.Closer); ok {
|
|
||||||
c.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
case func() (io.Reader, error):
|
|
||||||
body = rawBody.(func() (io.Reader, error))
|
|
||||||
tmp, err := body()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if lr, ok := tmp.(LenReader); ok {
|
|
||||||
contentLength = int64(lr.Len())
|
|
||||||
}
|
|
||||||
if c, ok := tmp.(io.Closer); ok {
|
|
||||||
c.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// If a regular byte slice, we can read it over and over via new
|
|
||||||
// readers
|
|
||||||
case []byte:
|
|
||||||
buf := rawBody.([]byte)
|
|
||||||
body = func() (io.Reader, error) {
|
|
||||||
return bytes.NewReader(buf), nil
|
|
||||||
}
|
|
||||||
contentLength = int64(len(buf))
|
|
||||||
|
|
||||||
// If a bytes.Buffer we can read the underlying byte slice over and
|
|
||||||
// over
|
|
||||||
case *bytes.Buffer:
|
|
||||||
buf := rawBody.(*bytes.Buffer)
|
|
||||||
body = func() (io.Reader, error) {
|
|
||||||
return bytes.NewReader(buf.Bytes()), nil
|
|
||||||
}
|
|
||||||
contentLength = int64(buf.Len())
|
|
||||||
|
|
||||||
// We prioritize *bytes.Reader here because we don't really want to
|
|
||||||
// deal with it seeking so want it to match here instead of the
|
|
||||||
// io.ReadSeeker case.
|
|
||||||
case *bytes.Reader:
|
|
||||||
buf, err := ioutil.ReadAll(rawBody.(*bytes.Reader))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
body = func() (io.Reader, error) {
|
|
||||||
return bytes.NewReader(buf), nil
|
|
||||||
}
|
|
||||||
contentLength = int64(len(buf))
|
|
||||||
|
|
||||||
// Compat case
|
|
||||||
case io.ReadSeeker:
|
|
||||||
raw := rawBody.(io.ReadSeeker)
|
|
||||||
body = func() (io.Reader, error) {
|
|
||||||
raw.Seek(0, 0)
|
|
||||||
return ioutil.NopCloser(raw), nil
|
|
||||||
}
|
|
||||||
if lr, ok := raw.(LenReader); ok {
|
|
||||||
contentLength = int64(lr.Len())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read all in so we can reset
|
|
||||||
case io.Reader:
|
|
||||||
buf, err := ioutil.ReadAll(rawBody.(io.Reader))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
body = func() (io.Reader, error) {
|
|
||||||
return bytes.NewReader(buf), nil
|
|
||||||
}
|
|
||||||
contentLength = int64(len(buf))
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("cannot handle type %T", rawBody)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
httpReq, err := http.NewRequest(method, url, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
httpReq.ContentLength = contentLength
|
|
||||||
|
|
||||||
return &Request{body, httpReq}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Logger interface allows to use other loggers than
|
|
||||||
// standard log.Logger.
|
|
||||||
type Logger interface {
|
|
||||||
Printf(string, ...interface{})
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequestLogHook allows a function to run before each retry. The HTTP
|
|
||||||
// request which will be made, and the retry number (0 for the initial
|
|
||||||
// request) are available to users. The internal logger is exposed to
|
|
||||||
// consumers.
|
|
||||||
type RequestLogHook func(Logger, *http.Request, int)
|
|
||||||
|
|
||||||
// ResponseLogHook is like RequestLogHook, but allows running a function
|
|
||||||
// on each HTTP response. This function will be invoked at the end of
|
|
||||||
// every HTTP request executed, regardless of whether a subsequent retry
|
|
||||||
// needs to be performed or not. If the response body is read or closed
|
|
||||||
// from this method, this will affect the response returned from Do().
|
|
||||||
type ResponseLogHook func(Logger, *http.Response)
|
|
||||||
|
|
||||||
// CheckRetry specifies a policy for handling retries. It is called
|
|
||||||
// following each request with the response and error values returned by
|
|
||||||
// the http.Client. If CheckRetry returns false, the Client stops retrying
|
|
||||||
// and returns the response to the caller. If CheckRetry returns an error,
|
|
||||||
// that error value is returned in lieu of the error from the request. The
|
|
||||||
// Client will close any response body when retrying, but if the retry is
|
|
||||||
// aborted it is up to the CheckResponse callback to properly close any
|
|
||||||
// response body before returning.
|
|
||||||
type CheckRetry func(ctx context.Context, resp *http.Response, err error) (bool, error)
|
|
||||||
|
|
||||||
// Backoff specifies a policy for how long to wait between retries.
|
|
||||||
// It is called after a failing request to determine the amount of time
|
|
||||||
// that should pass before trying again.
|
|
||||||
type Backoff func(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration
|
|
||||||
|
|
||||||
// ErrorHandler is called if retries are expired, containing the last status
|
|
||||||
// from the http library. If not specified, default behavior for the library is
|
|
||||||
// to close the body and return an error indicating how many tries were
|
|
||||||
// attempted. If overriding this, be sure to close the body if needed.
|
|
||||||
type ErrorHandler func(resp *http.Response, err error, numTries int) (*http.Response, error)
|
|
||||||
|
|
||||||
// Client is used to make HTTP requests. It adds additional functionality
|
|
||||||
// like automatic retries to tolerate minor outages.
|
|
||||||
type Client struct {
|
|
||||||
HTTPClient *http.Client // Internal HTTP client.
|
|
||||||
Logger Logger // Customer logger instance.
|
|
||||||
|
|
||||||
RetryWaitMin time.Duration // Minimum time to wait
|
|
||||||
RetryWaitMax time.Duration // Maximum time to wait
|
|
||||||
RetryMax int // Maximum number of retries
|
|
||||||
|
|
||||||
// RequestLogHook allows a user-supplied function to be called
|
|
||||||
// before each retry.
|
|
||||||
RequestLogHook RequestLogHook
|
|
||||||
|
|
||||||
// ResponseLogHook allows a user-supplied function to be called
|
|
||||||
// with the response from each HTTP request executed.
|
|
||||||
ResponseLogHook ResponseLogHook
|
|
||||||
|
|
||||||
// CheckRetry specifies the policy for handling retries, and is called
|
|
||||||
// after each request. The default policy is DefaultRetryPolicy.
|
|
||||||
CheckRetry CheckRetry
|
|
||||||
|
|
||||||
// Backoff specifies the policy for how long to wait between retries
|
|
||||||
Backoff Backoff
|
|
||||||
|
|
||||||
// ErrorHandler specifies the custom error handler to use, if any
|
|
||||||
ErrorHandler ErrorHandler
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewClient creates a new Client with default settings.
|
|
||||||
func NewClient() *Client {
|
|
||||||
return &Client{
|
|
||||||
HTTPClient: cleanhttp.DefaultClient(),
|
|
||||||
Logger: log.New(os.Stderr, "", log.LstdFlags),
|
|
||||||
RetryWaitMin: defaultRetryWaitMin,
|
|
||||||
RetryWaitMax: defaultRetryWaitMax,
|
|
||||||
RetryMax: defaultRetryMax,
|
|
||||||
CheckRetry: DefaultRetryPolicy,
|
|
||||||
Backoff: DefaultBackoff,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultRetryPolicy provides a default callback for Client.CheckRetry, which
|
|
||||||
// will retry on connection errors and server errors.
|
|
||||||
func DefaultRetryPolicy(ctx context.Context, resp *http.Response, err error) (bool, error) {
|
|
||||||
// do not retry on context.Canceled or context.DeadlineExceeded
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
return false, ctx.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return true, err
|
|
||||||
}
|
|
||||||
// Check the response code. We retry on 500-range responses to allow
|
|
||||||
// the server time to recover, as 500's are typically not permanent
|
|
||||||
// errors and may relate to outages on the server side. This will catch
|
|
||||||
// invalid response codes as well, like 0 and 999.
|
|
||||||
if resp.StatusCode == 0 || (resp.StatusCode >= 500 && resp.StatusCode != 501) {
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultBackoff provides a default callback for Client.Backoff which
|
|
||||||
// will perform exponential backoff based on the attempt number and limited
|
|
||||||
// by the provided minimum and maximum durations.
|
|
||||||
func DefaultBackoff(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration {
|
|
||||||
mult := math.Pow(2, float64(attemptNum)) * float64(min)
|
|
||||||
sleep := time.Duration(mult)
|
|
||||||
if float64(sleep) != mult || sleep > max {
|
|
||||||
sleep = max
|
|
||||||
}
|
|
||||||
return sleep
|
|
||||||
}
|
|
||||||
|
|
||||||
// LinearJitterBackoff provides a callback for Client.Backoff which will
|
|
||||||
// perform linear backoff based on the attempt number and with jitter to
|
|
||||||
// prevent a thundering herd.
|
|
||||||
//
|
|
||||||
// min and max here are *not* absolute values. The number to be multipled by
|
|
||||||
// the attempt number will be chosen at random from between them, thus they are
|
|
||||||
// bounding the jitter.
|
|
||||||
//
|
|
||||||
// For instance:
|
|
||||||
// * To get strictly linear backoff of one second increasing each retry, set
|
|
||||||
// both to one second (1s, 2s, 3s, 4s, ...)
|
|
||||||
// * To get a small amount of jitter centered around one second increasing each
|
|
||||||
// retry, set to around one second, such as a min of 800ms and max of 1200ms
|
|
||||||
// (892ms, 2102ms, 2945ms, 4312ms, ...)
|
|
||||||
// * To get extreme jitter, set to a very wide spread, such as a min of 100ms
|
|
||||||
// and a max of 20s (15382ms, 292ms, 51321ms, 35234ms, ...)
|
|
||||||
func LinearJitterBackoff(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration {
|
|
||||||
// attemptNum always starts at zero but we want to start at 1 for multiplication
|
|
||||||
attemptNum++
|
|
||||||
|
|
||||||
if max <= min {
|
|
||||||
// Unclear what to do here, or they are the same, so return min *
|
|
||||||
// attemptNum
|
|
||||||
return min * time.Duration(attemptNum)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Seed rand; doing this every time is fine
|
|
||||||
rand := rand.New(rand.NewSource(int64(time.Now().Nanosecond())))
|
|
||||||
|
|
||||||
// Pick a random number that lies somewhere between the min and max and
|
|
||||||
// multiply by the attemptNum. attemptNum starts at zero so we always
|
|
||||||
// increment here. We first get a random percentage, then apply that to the
|
|
||||||
// difference between min and max, and add to min.
|
|
||||||
jitter := rand.Float64() * float64(max-min)
|
|
||||||
jitterMin := int64(jitter) + int64(min)
|
|
||||||
return time.Duration(jitterMin * int64(attemptNum))
|
|
||||||
}
|
|
||||||
|
|
||||||
// PassthroughErrorHandler is an ErrorHandler that directly passes through the
|
|
||||||
// values from the net/http library for the final request. The body is not
|
|
||||||
// closed.
|
|
||||||
func PassthroughErrorHandler(resp *http.Response, err error, _ int) (*http.Response, error) {
|
|
||||||
return resp, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Do wraps calling an HTTP method with retries.
|
|
||||||
func (c *Client) Do(req *Request) (*http.Response, error) {
|
|
||||||
if c.Logger != nil {
|
|
||||||
c.Logger.Printf("[DEBUG] %s %s", req.Method, req.URL)
|
|
||||||
}
|
|
||||||
|
|
||||||
var resp *http.Response
|
|
||||||
var err error
|
|
||||||
|
|
||||||
for i := 0; ; i++ {
|
|
||||||
var code int // HTTP response code
|
|
||||||
|
|
||||||
// Always rewind the request body when non-nil.
|
|
||||||
if req.body != nil {
|
|
||||||
body, err := req.body()
|
|
||||||
if err != nil {
|
|
||||||
return resp, err
|
|
||||||
}
|
|
||||||
if c, ok := body.(io.ReadCloser); ok {
|
|
||||||
req.Request.Body = c
|
|
||||||
} else {
|
|
||||||
req.Request.Body = ioutil.NopCloser(body)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.RequestLogHook != nil {
|
|
||||||
c.RequestLogHook(c.Logger, req.Request, i)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attempt the request
|
|
||||||
resp, err = c.HTTPClient.Do(req.Request)
|
|
||||||
if resp != nil {
|
|
||||||
code = resp.StatusCode
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if we should continue with retries.
|
|
||||||
checkOK, checkErr := c.CheckRetry(req.Request.Context(), resp, err)
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
if c.Logger != nil {
|
|
||||||
c.Logger.Printf("[ERR] %s %s request failed: %v", req.Method, req.URL, err)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Call this here to maintain the behavior of logging all requests,
|
|
||||||
// even if CheckRetry signals to stop.
|
|
||||||
if c.ResponseLogHook != nil {
|
|
||||||
// Call the response logger function if provided.
|
|
||||||
c.ResponseLogHook(c.Logger, resp)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Now decide if we should continue.
|
|
||||||
if !checkOK {
|
|
||||||
if checkErr != nil {
|
|
||||||
err = checkErr
|
|
||||||
}
|
|
||||||
return resp, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// We do this before drainBody beause there's no need for the I/O if
|
|
||||||
// we're breaking out
|
|
||||||
remain := c.RetryMax - i
|
|
||||||
if remain <= 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
// We're going to retry, consume any response to reuse the connection.
|
|
||||||
if err == nil && resp != nil {
|
|
||||||
c.drainBody(resp.Body)
|
|
||||||
}
|
|
||||||
|
|
||||||
wait := c.Backoff(c.RetryWaitMin, c.RetryWaitMax, i, resp)
|
|
||||||
desc := fmt.Sprintf("%s %s", req.Method, req.URL)
|
|
||||||
if code > 0 {
|
|
||||||
desc = fmt.Sprintf("%s (status: %d)", desc, code)
|
|
||||||
}
|
|
||||||
if c.Logger != nil {
|
|
||||||
c.Logger.Printf("[DEBUG] %s: retrying in %s (%d left)", desc, wait, remain)
|
|
||||||
}
|
|
||||||
time.Sleep(wait)
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.ErrorHandler != nil {
|
|
||||||
return c.ErrorHandler(resp, err, c.RetryMax+1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// By default, we close the response body and return an error without
|
|
||||||
// returning the response
|
|
||||||
if resp != nil {
|
|
||||||
resp.Body.Close()
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("%s %s giving up after %d attempts",
|
|
||||||
req.Method, req.URL, c.RetryMax+1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Try to read the response body so we can reuse this connection.
|
|
||||||
func (c *Client) drainBody(body io.ReadCloser) {
|
|
||||||
defer body.Close()
|
|
||||||
_, err := io.Copy(ioutil.Discard, io.LimitReader(body, respReadLimit))
|
|
||||||
if err != nil {
|
|
||||||
if c.Logger != nil {
|
|
||||||
c.Logger.Printf("[ERR] error reading response body: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get is a shortcut for doing a GET request without making a new client.
|
|
||||||
func Get(url string) (*http.Response, error) {
|
|
||||||
return defaultClient.Get(url)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get is a convenience helper for doing simple GET requests.
|
|
||||||
func (c *Client) Get(url string) (*http.Response, error) {
|
|
||||||
req, err := NewRequest("GET", url, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return c.Do(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Head is a shortcut for doing a HEAD request without making a new client.
|
|
||||||
func Head(url string) (*http.Response, error) {
|
|
||||||
return defaultClient.Head(url)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Head is a convenience method for doing simple HEAD requests.
|
|
||||||
func (c *Client) Head(url string) (*http.Response, error) {
|
|
||||||
req, err := NewRequest("HEAD", url, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return c.Do(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Post is a shortcut for doing a POST request without making a new client.
|
|
||||||
func Post(url, bodyType string, body interface{}) (*http.Response, error) {
|
|
||||||
return defaultClient.Post(url, bodyType, body)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Post is a convenience method for doing simple POST requests.
|
|
||||||
func (c *Client) Post(url, bodyType string, body interface{}) (*http.Response, error) {
|
|
||||||
req, err := NewRequest("POST", url, body)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
req.Header.Set("Content-Type", bodyType)
|
|
||||||
return c.Do(req)
|
|
||||||
}
|
|
||||||
|
|
||||||
// PostForm is a shortcut to perform a POST with form data without creating
|
|
||||||
// a new client.
|
|
||||||
func PostForm(url string, data url.Values) (*http.Response, error) {
|
|
||||||
return defaultClient.PostForm(url, data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// PostForm is a convenience method for doing simple POST operations using
|
|
||||||
// pre-filled url.Values form data.
|
|
||||||
func (c *Client) PostForm(url string, data url.Values) (*http.Response, error) {
|
|
||||||
return c.Post(url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
|
|
||||||
}
|
|
3
vendor/github.com/hashicorp/go-retryablehttp/go.mod
generated
vendored
3
vendor/github.com/hashicorp/go-retryablehttp/go.mod
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
module github.com/hashicorp/go-retryablehttp
|
|
||||||
|
|
||||||
require github.com/hashicorp/go-cleanhttp v0.5.0
|
|
2
vendor/github.com/hashicorp/go-retryablehttp/go.sum
generated
vendored
2
vendor/github.com/hashicorp/go-retryablehttp/go.sum
generated
vendored
|
@ -1,2 +0,0 @@
|
||||||
github.com/hashicorp/go-cleanhttp v0.5.0 h1:wvCrVc9TjDls6+YGAF2hAifE1E5U1+b4tH6KdvN3Gig=
|
|
||||||
github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
|
|
12
vendor/github.com/hashicorp/go-rootcerts/.travis.yml
generated
vendored
12
vendor/github.com/hashicorp/go-rootcerts/.travis.yml
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.6
|
|
||||||
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
script: make test
|
|
363
vendor/github.com/hashicorp/go-rootcerts/LICENSE
generated
vendored
363
vendor/github.com/hashicorp/go-rootcerts/LICENSE
generated
vendored
|
@ -1,363 +0,0 @@
|
||||||
Mozilla Public License, version 2.0
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
|
|
||||||
1.1. "Contributor"
|
|
||||||
|
|
||||||
means each individual or legal entity that creates, contributes to the
|
|
||||||
creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. "Contributor Version"
|
|
||||||
|
|
||||||
means the combination of the Contributions of others (if any) used by a
|
|
||||||
Contributor and that particular Contributor's Contribution.
|
|
||||||
|
|
||||||
1.3. "Contribution"
|
|
||||||
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. "Covered Software"
|
|
||||||
|
|
||||||
means Source Code Form to which the initial Contributor has attached the
|
|
||||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
|
||||||
Modifications of such Source Code Form, in each case including portions
|
|
||||||
thereof.
|
|
||||||
|
|
||||||
1.5. "Incompatible With Secondary Licenses"
|
|
||||||
means
|
|
||||||
|
|
||||||
a. that the initial Contributor has attached the notice described in
|
|
||||||
Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
b. that the Covered Software was made available under the terms of
|
|
||||||
version 1.1 or earlier of the License, but not also under the terms of
|
|
||||||
a Secondary License.
|
|
||||||
|
|
||||||
1.6. "Executable Form"
|
|
||||||
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. "Larger Work"
|
|
||||||
|
|
||||||
means a work that combines Covered Software with other material, in a
|
|
||||||
separate file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. "License"
|
|
||||||
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. "Licensable"
|
|
||||||
|
|
||||||
means having the right to grant, to the maximum extent possible, whether
|
|
||||||
at the time of the initial grant or subsequently, any and all of the
|
|
||||||
rights conveyed by this License.
|
|
||||||
|
|
||||||
1.10. "Modifications"
|
|
||||||
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
a. any file in Source Code Form that results from an addition to,
|
|
||||||
deletion from, or modification of the contents of Covered Software; or
|
|
||||||
|
|
||||||
b. any new file in Source Code Form that contains any Covered Software.
|
|
||||||
|
|
||||||
1.11. "Patent Claims" of a Contributor
|
|
||||||
|
|
||||||
means any patent claim(s), including without limitation, method,
|
|
||||||
process, and apparatus claims, in any patent Licensable by such
|
|
||||||
Contributor that would be infringed, but for the grant of the License,
|
|
||||||
by the making, using, selling, offering for sale, having made, import,
|
|
||||||
or transfer of either its Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
1.12. "Secondary License"
|
|
||||||
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
|
||||||
General Public License, Version 2.1, the GNU Affero General Public
|
|
||||||
License, Version 3.0, or any later versions of those licenses.
|
|
||||||
|
|
||||||
1.13. "Source Code Form"
|
|
||||||
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. "You" (or "Your")
|
|
||||||
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, "You" includes any entity that controls, is
|
|
||||||
controlled by, or is under common control with You. For purposes of this
|
|
||||||
definition, "control" means (a) the power, direct or indirect, to cause
|
|
||||||
the direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
|
||||||
outstanding shares or beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
a. under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or
|
|
||||||
as part of a Larger Work; and
|
|
||||||
|
|
||||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
|
||||||
sale, have made, import, and otherwise transfer either its
|
|
||||||
Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution
|
|
||||||
become effective for each Contribution on the date the Contributor first
|
|
||||||
distributes such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under
|
|
||||||
this License. No additional rights or licenses will be implied from the
|
|
||||||
distribution or licensing of Covered Software under this License.
|
|
||||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
||||||
Contributor:
|
|
||||||
|
|
||||||
a. for any code that a Contributor has removed from Covered Software; or
|
|
||||||
|
|
||||||
b. for infringements caused by: (i) Your and any other third party's
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
c. under Patent Claims infringed by Covered Software in the absence of
|
|
||||||
its Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks,
|
|
||||||
or logos of any Contributor (except as may be necessary to comply with
|
|
||||||
the notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this
|
|
||||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
||||||
permitted under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its
|
|
||||||
Contributions are its original creation(s) or it has sufficient rights to
|
|
||||||
grant the rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under
|
|
||||||
applicable copyright doctrines of fair use, fair dealing, or other
|
|
||||||
equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
|
||||||
Section 2.1.
|
|
||||||
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under
|
|
||||||
the terms of this License. You must inform recipients that the Source
|
|
||||||
Code Form of the Covered Software is governed by the terms of this
|
|
||||||
License, and how they can obtain a copy of this License. You may not
|
|
||||||
attempt to alter or restrict the recipients' rights in the Source Code
|
|
||||||
Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
a. such Covered Software must also be made available in Source Code Form,
|
|
||||||
as described in Section 3.1, and You must inform recipients of the
|
|
||||||
Executable Form how they can obtain a copy of such Source Code Form by
|
|
||||||
reasonable means in a timely manner, at a charge no more than the cost
|
|
||||||
of distribution to the recipient; and
|
|
||||||
|
|
||||||
b. You may distribute such Executable Form under the terms of this
|
|
||||||
License, or sublicense it under different terms, provided that the
|
|
||||||
license for the Executable Form does not attempt to limit or alter the
|
|
||||||
recipients' rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for
|
|
||||||
the Covered Software. If the Larger Work is a combination of Covered
|
|
||||||
Software with a work governed by one or more Secondary Licenses, and the
|
|
||||||
Covered Software is not Incompatible With Secondary Licenses, this
|
|
||||||
License permits You to additionally distribute such Covered Software
|
|
||||||
under the terms of such Secondary License(s), so that the recipient of
|
|
||||||
the Larger Work may, at their option, further distribute the Covered
|
|
||||||
Software under the terms of either this License or such Secondary
|
|
||||||
License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices
|
|
||||||
(including copyright notices, patent notices, disclaimers of warranty, or
|
|
||||||
limitations of liability) contained within the Source Code Form of the
|
|
||||||
Covered Software, except that You may alter any license notices to the
|
|
||||||
extent required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on
|
|
||||||
behalf of any Contributor. You must make it absolutely clear that any
|
|
||||||
such warranty, support, indemnity, or liability obligation is offered by
|
|
||||||
You alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this License
|
|
||||||
with respect to some or all of the Covered Software due to statute,
|
|
||||||
judicial order, or regulation then You must: (a) comply with the terms of
|
|
||||||
this License to the maximum extent possible; and (b) describe the
|
|
||||||
limitations and the code they affect. Such description must be placed in a
|
|
||||||
text file included with all distributions of the Covered Software under
|
|
||||||
this License. Except to the extent prohibited by statute or regulation,
|
|
||||||
such description must be sufficiently detailed for a recipient of ordinary
|
|
||||||
skill to be able to understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically if You
|
|
||||||
fail to comply with any of its terms. However, if You become compliant,
|
|
||||||
then the rights granted under this License from a particular Contributor
|
|
||||||
are reinstated (a) provisionally, unless and until such Contributor
|
|
||||||
explicitly and finally terminates Your grants, and (b) on an ongoing
|
|
||||||
basis, if such Contributor fails to notify You of the non-compliance by
|
|
||||||
some reasonable means prior to 60 days after You have come back into
|
|
||||||
compliance. Moreover, Your grants from a particular Contributor are
|
|
||||||
reinstated on an ongoing basis if such Contributor notifies You of the
|
|
||||||
non-compliance by some reasonable means, this is the first time You have
|
|
||||||
received notice of non-compliance with this License from such
|
|
||||||
Contributor, and You become compliant prior to 30 days after Your receipt
|
|
||||||
of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions,
|
|
||||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
||||||
directly or indirectly infringes any patent, then the rights granted to
|
|
||||||
You by any and all Contributors for the Covered Software under Section
|
|
||||||
2.1 of this License shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
|
||||||
license agreements (excluding distributors and resellers) which have been
|
|
||||||
validly granted by You or Your distributors under this License prior to
|
|
||||||
termination shall survive termination.
|
|
||||||
|
|
||||||
6. Disclaimer of Warranty
|
|
||||||
|
|
||||||
Covered Software is provided under this License on an "as is" basis,
|
|
||||||
without warranty of any kind, either expressed, implied, or statutory,
|
|
||||||
including, without limitation, warranties that the Covered Software is free
|
|
||||||
of defects, merchantable, fit for a particular purpose or non-infringing.
|
|
||||||
The entire risk as to the quality and performance of the Covered Software
|
|
||||||
is with You. Should any Covered Software prove defective in any respect,
|
|
||||||
You (not any Contributor) assume the cost of any necessary servicing,
|
|
||||||
repair, or correction. This disclaimer of warranty constitutes an essential
|
|
||||||
part of this License. No use of any Covered Software is authorized under
|
|
||||||
this License except under this disclaimer.
|
|
||||||
|
|
||||||
7. Limitation of Liability
|
|
||||||
|
|
||||||
Under no circumstances and under no legal theory, whether tort (including
|
|
||||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
|
||||||
distributes Covered Software as permitted above, be liable to You for any
|
|
||||||
direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character including, without limitation, damages for lost profits, loss of
|
|
||||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses, even if such party shall have been
|
|
||||||
informed of the possibility of such damages. This limitation of liability
|
|
||||||
shall not apply to liability for death or personal injury resulting from
|
|
||||||
such party's negligence to the extent applicable law prohibits such
|
|
||||||
limitation. Some jurisdictions do not allow the exclusion or limitation of
|
|
||||||
incidental or consequential damages, so this exclusion and limitation may
|
|
||||||
not apply to You.
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the courts
|
|
||||||
of a jurisdiction where the defendant maintains its principal place of
|
|
||||||
business and such litigation shall be governed by laws of that
|
|
||||||
jurisdiction, without reference to its conflict-of-law provisions. Nothing
|
|
||||||
in this Section shall prevent a party's ability to bring cross-claims or
|
|
||||||
counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject
|
|
||||||
matter hereof. If any provision of this License is held to be
|
|
||||||
unenforceable, such provision shall be reformed only to the extent
|
|
||||||
necessary to make it enforceable. Any law or regulation which provides that
|
|
||||||
the language of a contract shall be construed against the drafter shall not
|
|
||||||
be used to construe this License against a Contributor.
|
|
||||||
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version
|
|
||||||
of the License under which You originally received the Covered Software,
|
|
||||||
or under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a
|
|
||||||
modified version of this License if you rename the license and remove
|
|
||||||
any references to the name of the license steward (except to note that
|
|
||||||
such modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
||||||
Licenses If You choose to distribute Source Code Form that is
|
|
||||||
Incompatible With Secondary Licenses under the terms of this version of
|
|
||||||
the License, the notice described in Exhibit B of this License must be
|
|
||||||
attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
|
|
||||||
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
|
|
||||||
http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular file,
|
|
||||||
then You may include the notice in a location (such as a LICENSE file in a
|
|
||||||
relevant directory) where a recipient would be likely to look for such a
|
|
||||||
notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
||||||
|
|
||||||
This Source Code Form is "Incompatible
|
|
||||||
With Secondary Licenses", as defined by
|
|
||||||
the Mozilla Public License, v. 2.0.
|
|
||||||
|
|
8
vendor/github.com/hashicorp/go-rootcerts/Makefile
generated
vendored
8
vendor/github.com/hashicorp/go-rootcerts/Makefile
generated
vendored
|
@ -1,8 +0,0 @@
|
||||||
TEST?=./...
|
|
||||||
|
|
||||||
test:
|
|
||||||
go test $(TEST) $(TESTARGS) -timeout=3s -parallel=4
|
|
||||||
go vet $(TEST)
|
|
||||||
go test $(TEST) -race
|
|
||||||
|
|
||||||
.PHONY: test
|
|
43
vendor/github.com/hashicorp/go-rootcerts/README.md
generated
vendored
43
vendor/github.com/hashicorp/go-rootcerts/README.md
generated
vendored
|
@ -1,43 +0,0 @@
|
||||||
# rootcerts
|
|
||||||
|
|
||||||
Functions for loading root certificates for TLS connections.
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
Go's standard library `crypto/tls` provides a common mechanism for configuring
|
|
||||||
TLS connections in `tls.Config`. The `RootCAs` field on this struct is a pool
|
|
||||||
of certificates for the client to use as a trust store when verifying server
|
|
||||||
certificates.
|
|
||||||
|
|
||||||
This library contains utility functions for loading certificates destined for
|
|
||||||
that field, as well as one other important thing:
|
|
||||||
|
|
||||||
When the `RootCAs` field is `nil`, the standard library attempts to load the
|
|
||||||
host's root CA set. This behavior is OS-specific, and the Darwin
|
|
||||||
implementation contains [a bug that prevents trusted certificates from the
|
|
||||||
System and Login keychains from being loaded][1]. This library contains
|
|
||||||
Darwin-specific behavior that works around that bug.
|
|
||||||
|
|
||||||
[1]: https://github.com/golang/go/issues/14514
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
Here's a snippet demonstrating how this library is meant to be used:
|
|
||||||
|
|
||||||
```go
|
|
||||||
func httpClient() (*http.Client, error)
|
|
||||||
tlsConfig := &tls.Config{}
|
|
||||||
err := rootcerts.ConfigureTLS(tlsConfig, &rootcerts.Config{
|
|
||||||
CAFile: os.Getenv("MYAPP_CAFILE"),
|
|
||||||
CAPath: os.Getenv("MYAPP_CAPATH"),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
c := cleanhttp.DefaultClient()
|
|
||||||
t := cleanhttp.DefaultTransport()
|
|
||||||
t.TLSClientConfig = tlsConfig
|
|
||||||
c.Transport = t
|
|
||||||
return c, nil
|
|
||||||
}
|
|
||||||
```
|
|
9
vendor/github.com/hashicorp/go-rootcerts/doc.go
generated
vendored
9
vendor/github.com/hashicorp/go-rootcerts/doc.go
generated
vendored
|
@ -1,9 +0,0 @@
|
||||||
// Package rootcerts contains functions to aid in loading CA certificates for
|
|
||||||
// TLS connections.
|
|
||||||
//
|
|
||||||
// In addition, its default behavior on Darwin works around an open issue [1]
|
|
||||||
// in Go's crypto/x509 that prevents certicates from being loaded from the
|
|
||||||
// System or Login keychains.
|
|
||||||
//
|
|
||||||
// [1] https://github.com/golang/go/issues/14514
|
|
||||||
package rootcerts
|
|
3
vendor/github.com/hashicorp/go-rootcerts/go.mod
generated
vendored
3
vendor/github.com/hashicorp/go-rootcerts/go.mod
generated
vendored
|
@ -1,3 +0,0 @@
|
||||||
module github.com/hashicorp/go-rootcerts
|
|
||||||
|
|
||||||
require github.com/mitchellh/go-homedir v1.0.0
|
|
2
vendor/github.com/hashicorp/go-rootcerts/go.sum
generated
vendored
2
vendor/github.com/hashicorp/go-rootcerts/go.sum
generated
vendored
|
@ -1,2 +0,0 @@
|
||||||
github.com/mitchellh/go-homedir v1.0.0 h1:vKb8ShqSby24Yrqr/yDYkuFz8d0WUjys40rvnGC8aR0=
|
|
||||||
github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
|
|
103
vendor/github.com/hashicorp/go-rootcerts/rootcerts.go
generated
vendored
103
vendor/github.com/hashicorp/go-rootcerts/rootcerts.go
generated
vendored
|
@ -1,103 +0,0 @@
|
||||||
package rootcerts
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/tls"
|
|
||||||
"crypto/x509"
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Config determines where LoadCACerts will load certificates from. When both
|
|
||||||
// CAFile and CAPath are blank, this library's functions will either load
|
|
||||||
// system roots explicitly and return them, or set the CertPool to nil to allow
|
|
||||||
// Go's standard library to load system certs.
|
|
||||||
type Config struct {
|
|
||||||
// CAFile is a path to a PEM-encoded certificate file or bundle. Takes
|
|
||||||
// precedence over CAPath.
|
|
||||||
CAFile string
|
|
||||||
|
|
||||||
// CAPath is a path to a directory populated with PEM-encoded certificates.
|
|
||||||
CAPath string
|
|
||||||
}
|
|
||||||
|
|
||||||
// ConfigureTLS sets up the RootCAs on the provided tls.Config based on the
|
|
||||||
// Config specified.
|
|
||||||
func ConfigureTLS(t *tls.Config, c *Config) error {
|
|
||||||
if t == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
pool, err := LoadCACerts(c)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
t.RootCAs = pool
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadCACerts loads a CertPool based on the Config specified.
|
|
||||||
func LoadCACerts(c *Config) (*x509.CertPool, error) {
|
|
||||||
if c == nil {
|
|
||||||
c = &Config{}
|
|
||||||
}
|
|
||||||
if c.CAFile != "" {
|
|
||||||
return LoadCAFile(c.CAFile)
|
|
||||||
}
|
|
||||||
if c.CAPath != "" {
|
|
||||||
return LoadCAPath(c.CAPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
return LoadSystemCAs()
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadCAFile loads a single PEM-encoded file from the path specified.
|
|
||||||
func LoadCAFile(caFile string) (*x509.CertPool, error) {
|
|
||||||
pool := x509.NewCertPool()
|
|
||||||
|
|
||||||
pem, err := ioutil.ReadFile(caFile)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("Error loading CA File: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ok := pool.AppendCertsFromPEM(pem)
|
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("Error loading CA File: Couldn't parse PEM in: %s", caFile)
|
|
||||||
}
|
|
||||||
|
|
||||||
return pool, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadCAPath walks the provided path and loads all certificates encounted into
|
|
||||||
// a pool.
|
|
||||||
func LoadCAPath(caPath string) (*x509.CertPool, error) {
|
|
||||||
pool := x509.NewCertPool()
|
|
||||||
walkFn := func(path string, info os.FileInfo, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.IsDir() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
pem, err := ioutil.ReadFile(path)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("Error loading file from CAPath: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ok := pool.AppendCertsFromPEM(pem)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("Error loading CA Path: Couldn't parse PEM in: %s", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err := filepath.Walk(caPath, walkFn)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return pool, nil
|
|
||||||
}
|
|
12
vendor/github.com/hashicorp/go-rootcerts/rootcerts_base.go
generated
vendored
12
vendor/github.com/hashicorp/go-rootcerts/rootcerts_base.go
generated
vendored
|
@ -1,12 +0,0 @@
|
||||||
// +build !darwin
|
|
||||||
|
|
||||||
package rootcerts
|
|
||||||
|
|
||||||
import "crypto/x509"
|
|
||||||
|
|
||||||
// LoadSystemCAs does nothing on non-Darwin systems. We return nil so that
|
|
||||||
// default behavior of standard TLS config libraries is triggered, which is to
|
|
||||||
// load system certs.
|
|
||||||
func LoadSystemCAs() (*x509.CertPool, error) {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
48
vendor/github.com/hashicorp/go-rootcerts/rootcerts_darwin.go
generated
vendored
48
vendor/github.com/hashicorp/go-rootcerts/rootcerts_darwin.go
generated
vendored
|
@ -1,48 +0,0 @@
|
||||||
package rootcerts
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/x509"
|
|
||||||
"os/exec"
|
|
||||||
"path"
|
|
||||||
|
|
||||||
"github.com/mitchellh/go-homedir"
|
|
||||||
)
|
|
||||||
|
|
||||||
// LoadSystemCAs has special behavior on Darwin systems to work around
|
|
||||||
func LoadSystemCAs() (*x509.CertPool, error) {
|
|
||||||
pool := x509.NewCertPool()
|
|
||||||
|
|
||||||
for _, keychain := range certKeychains() {
|
|
||||||
err := addCertsFromKeychain(pool, keychain)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return pool, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func addCertsFromKeychain(pool *x509.CertPool, keychain string) error {
|
|
||||||
cmd := exec.Command("/usr/bin/security", "find-certificate", "-a", "-p", keychain)
|
|
||||||
data, err := cmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
pool.AppendCertsFromPEM(data)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func certKeychains() []string {
|
|
||||||
keychains := []string{
|
|
||||||
"/System/Library/Keychains/SystemRootCertificates.keychain",
|
|
||||||
"/Library/Keychains/System.keychain",
|
|
||||||
}
|
|
||||||
home, err := homedir.Dir()
|
|
||||||
if err == nil {
|
|
||||||
loginKeychain := path.Join(home, "Library", "Keychains", "login.keychain")
|
|
||||||
keychains = append(keychains, loginKeychain)
|
|
||||||
}
|
|
||||||
return keychains
|
|
||||||
}
|
|
26
vendor/github.com/hashicorp/go-sockaddr/.gitignore
generated
vendored
26
vendor/github.com/hashicorp/go-sockaddr/.gitignore
generated
vendored
|
@ -1,26 +0,0 @@
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
*.test
|
|
||||||
*.prof
|
|
||||||
.cover.out*
|
|
||||||
coverage.html
|
|
65
vendor/github.com/hashicorp/go-sockaddr/GNUmakefile
generated
vendored
65
vendor/github.com/hashicorp/go-sockaddr/GNUmakefile
generated
vendored
|
@ -1,65 +0,0 @@
|
||||||
TOOLS= golang.org/x/tools/cover
|
|
||||||
GOCOVER_TMPFILE?= $(GOCOVER_FILE).tmp
|
|
||||||
GOCOVER_FILE?= .cover.out
|
|
||||||
GOCOVERHTML?= coverage.html
|
|
||||||
FIND=`/usr/bin/which 2> /dev/null gfind find | /usr/bin/grep -v ^no | /usr/bin/head -n 1`
|
|
||||||
XARGS=`/usr/bin/which 2> /dev/null gxargs xargs | /usr/bin/grep -v ^no | /usr/bin/head -n 1`
|
|
||||||
|
|
||||||
test:: $(GOCOVER_FILE)
|
|
||||||
@$(MAKE) -C cmd/sockaddr test
|
|
||||||
|
|
||||||
cover:: coverage_report
|
|
||||||
|
|
||||||
$(GOCOVER_FILE)::
|
|
||||||
@${FIND} . -type d ! -path '*cmd*' ! -path '*.git*' -print0 | ${XARGS} -0 -I % sh -ec "cd % && rm -f $(GOCOVER_TMPFILE) && go test -coverprofile=$(GOCOVER_TMPFILE)"
|
|
||||||
|
|
||||||
@echo 'mode: set' > $(GOCOVER_FILE)
|
|
||||||
@${FIND} . -type f ! -path '*cmd*' ! -path '*.git*' -name "$(GOCOVER_TMPFILE)" -print0 | ${XARGS} -0 -n1 cat $(GOCOVER_TMPFILE) | grep -v '^mode: ' >> ${PWD}/$(GOCOVER_FILE)
|
|
||||||
|
|
||||||
$(GOCOVERHTML): $(GOCOVER_FILE)
|
|
||||||
go tool cover -html=$(GOCOVER_FILE) -o $(GOCOVERHTML)
|
|
||||||
|
|
||||||
coverage_report:: $(GOCOVER_FILE)
|
|
||||||
go tool cover -html=$(GOCOVER_FILE)
|
|
||||||
|
|
||||||
audit_tools::
|
|
||||||
@go get -u github.com/golang/lint/golint && echo "Installed golint:"
|
|
||||||
@go get -u github.com/fzipp/gocyclo && echo "Installed gocyclo:"
|
|
||||||
@go get -u github.com/remyoudompheng/go-misc/deadcode && echo "Installed deadcode:"
|
|
||||||
@go get -u github.com/client9/misspell/cmd/misspell && echo "Installed misspell:"
|
|
||||||
@go get -u github.com/gordonklaus/ineffassign && echo "Installed ineffassign:"
|
|
||||||
|
|
||||||
audit::
|
|
||||||
deadcode
|
|
||||||
go tool vet -all *.go
|
|
||||||
go tool vet -shadow=true *.go
|
|
||||||
golint *.go
|
|
||||||
ineffassign .
|
|
||||||
gocyclo -over 65 *.go
|
|
||||||
misspell *.go
|
|
||||||
|
|
||||||
clean::
|
|
||||||
rm -f $(GOCOVER_FILE) $(GOCOVERHTML)
|
|
||||||
|
|
||||||
dev::
|
|
||||||
@go build
|
|
||||||
@$(MAKE) -B -C cmd/sockaddr sockaddr
|
|
||||||
|
|
||||||
install::
|
|
||||||
@go install
|
|
||||||
@$(MAKE) -C cmd/sockaddr install
|
|
||||||
|
|
||||||
doc::
|
|
||||||
@echo Visit: http://127.0.0.1:6161/pkg/github.com/hashicorp/go-sockaddr/
|
|
||||||
godoc -http=:6161 -goroot $GOROOT
|
|
||||||
|
|
||||||
world::
|
|
||||||
@set -e; \
|
|
||||||
for os in solaris darwin freebsd linux windows; do \
|
|
||||||
for arch in amd64; do \
|
|
||||||
printf "Building on %s-%s\n" "$${os}" "$${arch}" ; \
|
|
||||||
env GOOS="$${os}" GOARCH="$${arch}" go build -o /dev/null; \
|
|
||||||
done; \
|
|
||||||
done
|
|
||||||
|
|
||||||
$(MAKE) -C cmd/sockaddr world
|
|
373
vendor/github.com/hashicorp/go-sockaddr/LICENSE
generated
vendored
373
vendor/github.com/hashicorp/go-sockaddr/LICENSE
generated
vendored
|
@ -1,373 +0,0 @@
|
||||||
Mozilla Public License Version 2.0
|
|
||||||
==================================
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
--------------
|
|
||||||
|
|
||||||
1.1. "Contributor"
|
|
||||||
means each individual or legal entity that creates, contributes to
|
|
||||||
the creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. "Contributor Version"
|
|
||||||
means the combination of the Contributions of others (if any) used
|
|
||||||
by a Contributor and that particular Contributor's Contribution.
|
|
||||||
|
|
||||||
1.3. "Contribution"
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. "Covered Software"
|
|
||||||
means Source Code Form to which the initial Contributor has attached
|
|
||||||
the notice in Exhibit A, the Executable Form of such Source Code
|
|
||||||
Form, and Modifications of such Source Code Form, in each case
|
|
||||||
including portions thereof.
|
|
||||||
|
|
||||||
1.5. "Incompatible With Secondary Licenses"
|
|
||||||
means
|
|
||||||
|
|
||||||
(a) that the initial Contributor has attached the notice described
|
|
||||||
in Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
(b) that the Covered Software was made available under the terms of
|
|
||||||
version 1.1 or earlier of the License, but not also under the
|
|
||||||
terms of a Secondary License.
|
|
||||||
|
|
||||||
1.6. "Executable Form"
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. "Larger Work"
|
|
||||||
means a work that combines Covered Software with other material, in
|
|
||||||
a separate file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. "License"
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. "Licensable"
|
|
||||||
means having the right to grant, to the maximum extent possible,
|
|
||||||
whether at the time of the initial grant or subsequently, any and
|
|
||||||
all of the rights conveyed by this License.
|
|
||||||
|
|
||||||
1.10. "Modifications"
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
(a) any file in Source Code Form that results from an addition to,
|
|
||||||
deletion from, or modification of the contents of Covered
|
|
||||||
Software; or
|
|
||||||
|
|
||||||
(b) any new file in Source Code Form that contains any Covered
|
|
||||||
Software.
|
|
||||||
|
|
||||||
1.11. "Patent Claims" of a Contributor
|
|
||||||
means any patent claim(s), including without limitation, method,
|
|
||||||
process, and apparatus claims, in any patent Licensable by such
|
|
||||||
Contributor that would be infringed, but for the grant of the
|
|
||||||
License, by the making, using, selling, offering for sale, having
|
|
||||||
made, import, or transfer of either its Contributions or its
|
|
||||||
Contributor Version.
|
|
||||||
|
|
||||||
1.12. "Secondary License"
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU
|
|
||||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
||||||
Public License, Version 3.0, or any later versions of those
|
|
||||||
licenses.
|
|
||||||
|
|
||||||
1.13. "Source Code Form"
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. "You" (or "Your")
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, "You" includes any entity that
|
|
||||||
controls, is controlled by, or is under common control with You. For
|
|
||||||
purposes of this definition, "control" means (a) the power, direct
|
|
||||||
or indirect, to cause the direction or management of such entity,
|
|
||||||
whether by contract or otherwise, or (b) ownership of more than
|
|
||||||
fifty percent (50%) of the outstanding shares or beneficial
|
|
||||||
ownership of such entity.
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
(a) under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or
|
|
||||||
as part of a Larger Work; and
|
|
||||||
|
|
||||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
||||||
for sale, have made, import, and otherwise transfer either its
|
|
||||||
Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution
|
|
||||||
become effective for each Contribution on the date the Contributor first
|
|
||||||
distributes such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under
|
|
||||||
this License. No additional rights or licenses will be implied from the
|
|
||||||
distribution or licensing of Covered Software under this License.
|
|
||||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
||||||
Contributor:
|
|
||||||
|
|
||||||
(a) for any code that a Contributor has removed from Covered Software;
|
|
||||||
or
|
|
||||||
|
|
||||||
(b) for infringements caused by: (i) Your and any other third party's
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
||||||
its Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks,
|
|
||||||
or logos of any Contributor (except as may be necessary to comply with
|
|
||||||
the notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this
|
|
||||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
||||||
permitted under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its
|
|
||||||
Contributions are its original creation(s) or it has sufficient rights
|
|
||||||
to grant the rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under
|
|
||||||
applicable copyright doctrines of fair use, fair dealing, or other
|
|
||||||
equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
||||||
in Section 2.1.
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under
|
|
||||||
the terms of this License. You must inform recipients that the Source
|
|
||||||
Code Form of the Covered Software is governed by the terms of this
|
|
||||||
License, and how they can obtain a copy of this License. You may not
|
|
||||||
attempt to alter or restrict the recipients' rights in the Source Code
|
|
||||||
Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
(a) such Covered Software must also be made available in Source Code
|
|
||||||
Form, as described in Section 3.1, and You must inform recipients of
|
|
||||||
the Executable Form how they can obtain a copy of such Source Code
|
|
||||||
Form by reasonable means in a timely manner, at a charge no more
|
|
||||||
than the cost of distribution to the recipient; and
|
|
||||||
|
|
||||||
(b) You may distribute such Executable Form under the terms of this
|
|
||||||
License, or sublicense it under different terms, provided that the
|
|
||||||
license for the Executable Form does not attempt to limit or alter
|
|
||||||
the recipients' rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for
|
|
||||||
the Covered Software. If the Larger Work is a combination of Covered
|
|
||||||
Software with a work governed by one or more Secondary Licenses, and the
|
|
||||||
Covered Software is not Incompatible With Secondary Licenses, this
|
|
||||||
License permits You to additionally distribute such Covered Software
|
|
||||||
under the terms of such Secondary License(s), so that the recipient of
|
|
||||||
the Larger Work may, at their option, further distribute the Covered
|
|
||||||
Software under the terms of either this License or such Secondary
|
|
||||||
License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices
|
|
||||||
(including copyright notices, patent notices, disclaimers of warranty,
|
|
||||||
or limitations of liability) contained within the Source Code Form of
|
|
||||||
the Covered Software, except that You may alter any license notices to
|
|
||||||
the extent required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on
|
|
||||||
behalf of any Contributor. You must make it absolutely clear that any
|
|
||||||
such warranty, support, indemnity, or liability obligation is offered by
|
|
||||||
You alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
---------------------------------------------------
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this
|
|
||||||
License with respect to some or all of the Covered Software due to
|
|
||||||
statute, judicial order, or regulation then You must: (a) comply with
|
|
||||||
the terms of this License to the maximum extent possible; and (b)
|
|
||||||
describe the limitations and the code they affect. Such description must
|
|
||||||
be placed in a text file included with all distributions of the Covered
|
|
||||||
Software under this License. Except to the extent prohibited by statute
|
|
||||||
or regulation, such description must be sufficiently detailed for a
|
|
||||||
recipient of ordinary skill to be able to understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
--------------
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically
|
|
||||||
if You fail to comply with any of its terms. However, if You become
|
|
||||||
compliant, then the rights granted under this License from a particular
|
|
||||||
Contributor are reinstated (a) provisionally, unless and until such
|
|
||||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
||||||
ongoing basis, if such Contributor fails to notify You of the
|
|
||||||
non-compliance by some reasonable means prior to 60 days after You have
|
|
||||||
come back into compliance. Moreover, Your grants from a particular
|
|
||||||
Contributor are reinstated on an ongoing basis if such Contributor
|
|
||||||
notifies You of the non-compliance by some reasonable means, this is the
|
|
||||||
first time You have received notice of non-compliance with this License
|
|
||||||
from such Contributor, and You become compliant prior to 30 days after
|
|
||||||
Your receipt of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions,
|
|
||||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
||||||
directly or indirectly infringes any patent, then the rights granted to
|
|
||||||
You by any and all Contributors for the Covered Software under Section
|
|
||||||
2.1 of this License shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
||||||
end user license agreements (excluding distributors and resellers) which
|
|
||||||
have been validly granted by You or Your distributors under this License
|
|
||||||
prior to termination shall survive termination.
|
|
||||||
|
|
||||||
************************************************************************
|
|
||||||
* *
|
|
||||||
* 6. Disclaimer of Warranty *
|
|
||||||
* ------------------------- *
|
|
||||||
* *
|
|
||||||
* Covered Software is provided under this License on an "as is" *
|
|
||||||
* basis, without warranty of any kind, either expressed, implied, or *
|
|
||||||
* statutory, including, without limitation, warranties that the *
|
|
||||||
* Covered Software is free of defects, merchantable, fit for a *
|
|
||||||
* particular purpose or non-infringing. The entire risk as to the *
|
|
||||||
* quality and performance of the Covered Software is with You. *
|
|
||||||
* Should any Covered Software prove defective in any respect, You *
|
|
||||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
||||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
||||||
* essential part of this License. No use of any Covered Software is *
|
|
||||||
* authorized under this License except under this disclaimer. *
|
|
||||||
* *
|
|
||||||
************************************************************************
|
|
||||||
|
|
||||||
************************************************************************
|
|
||||||
* *
|
|
||||||
* 7. Limitation of Liability *
|
|
||||||
* -------------------------- *
|
|
||||||
* *
|
|
||||||
* Under no circumstances and under no legal theory, whether tort *
|
|
||||||
* (including negligence), contract, or otherwise, shall any *
|
|
||||||
* Contributor, or anyone who distributes Covered Software as *
|
|
||||||
* permitted above, be liable to You for any direct, indirect, *
|
|
||||||
* special, incidental, or consequential damages of any character *
|
|
||||||
* including, without limitation, damages for lost profits, loss of *
|
|
||||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
||||||
* and all other commercial damages or losses, even if such party *
|
|
||||||
* shall have been informed of the possibility of such damages. This *
|
|
||||||
* limitation of liability shall not apply to liability for death or *
|
|
||||||
* personal injury resulting from such party's negligence to the *
|
|
||||||
* extent applicable law prohibits such limitation. Some *
|
|
||||||
* jurisdictions do not allow the exclusion or limitation of *
|
|
||||||
* incidental or consequential damages, so this exclusion and *
|
|
||||||
* limitation may not apply to You. *
|
|
||||||
* *
|
|
||||||
************************************************************************
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the
|
|
||||||
courts of a jurisdiction where the defendant maintains its principal
|
|
||||||
place of business and such litigation shall be governed by laws of that
|
|
||||||
jurisdiction, without reference to its conflict-of-law provisions.
|
|
||||||
Nothing in this Section shall prevent a party's ability to bring
|
|
||||||
cross-claims or counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
----------------
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject
|
|
||||||
matter hereof. If any provision of this License is held to be
|
|
||||||
unenforceable, such provision shall be reformed only to the extent
|
|
||||||
necessary to make it enforceable. Any law or regulation which provides
|
|
||||||
that the language of a contract shall be construed against the drafter
|
|
||||||
shall not be used to construe this License against a Contributor.
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version
|
|
||||||
of the License under which You originally received the Covered Software,
|
|
||||||
or under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a
|
|
||||||
modified version of this License if you rename the license and remove
|
|
||||||
any references to the name of the license steward (except to note that
|
|
||||||
such modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
||||||
Licenses
|
|
||||||
|
|
||||||
If You choose to distribute Source Code Form that is Incompatible With
|
|
||||||
Secondary Licenses under the terms of this version of the License, the
|
|
||||||
notice described in Exhibit B of this License must be attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
-------------------------------------------
|
|
||||||
|
|
||||||
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 http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular
|
|
||||||
file, then You may include the notice in a location (such as a LICENSE
|
|
||||||
file in a relevant directory) where a recipient would be likely to look
|
|
||||||
for such a notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
||||||
---------------------------------------------------------
|
|
||||||
|
|
||||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
||||||
defined by the Mozilla Public License, v. 2.0.
|
|
118
vendor/github.com/hashicorp/go-sockaddr/README.md
generated
vendored
118
vendor/github.com/hashicorp/go-sockaddr/README.md
generated
vendored
|
@ -1,118 +0,0 @@
|
||||||
# go-sockaddr
|
|
||||||
|
|
||||||
## `sockaddr` Library
|
|
||||||
|
|
||||||
Socket address convenience functions for Go. `go-sockaddr` is a convenience
|
|
||||||
library that makes doing the right thing with IP addresses easy. `go-sockaddr`
|
|
||||||
is loosely modeled after the UNIX `sockaddr_t` and creates a union of the family
|
|
||||||
of `sockaddr_t` types (see below for an ascii diagram). Library documentation
|
|
||||||
is available
|
|
||||||
at
|
|
||||||
[https://godoc.org/github.com/hashicorp/go-sockaddr](https://godoc.org/github.com/hashicorp/go-sockaddr).
|
|
||||||
The primary intent of the library was to make it possible to define heuristics
|
|
||||||
for selecting the correct IP addresses when a configuration is evaluated at
|
|
||||||
runtime. See
|
|
||||||
the
|
|
||||||
[docs](https://godoc.org/github.com/hashicorp/go-sockaddr),
|
|
||||||
[`template` package](https://godoc.org/github.com/hashicorp/go-sockaddr/template),
|
|
||||||
tests,
|
|
||||||
and
|
|
||||||
[CLI utility](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr)
|
|
||||||
for details and hints as to how to use this library.
|
|
||||||
|
|
||||||
For example, with this library it is possible to find an IP address that:
|
|
||||||
|
|
||||||
* is attached to a default route
|
|
||||||
([`GetDefaultInterfaces()`](https://godoc.org/github.com/hashicorp/go-sockaddr#GetDefaultInterfaces))
|
|
||||||
* is contained within a CIDR block ([`IfByNetwork()`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByNetwork))
|
|
||||||
* is an RFC1918 address
|
|
||||||
([`IfByRFC("1918")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByRFC))
|
|
||||||
* is ordered
|
|
||||||
([`OrderedIfAddrBy(args)`](https://godoc.org/github.com/hashicorp/go-sockaddr#OrderedIfAddrBy) where
|
|
||||||
`args` includes, but is not limited
|
|
||||||
to,
|
|
||||||
[`AscIfType`](https://godoc.org/github.com/hashicorp/go-sockaddr#AscIfType),
|
|
||||||
[`AscNetworkSize`](https://godoc.org/github.com/hashicorp/go-sockaddr#AscNetworkSize))
|
|
||||||
* excludes all IPv6 addresses
|
|
||||||
([`IfByType("^(IPv4)$")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByType))
|
|
||||||
* is larger than a `/32`
|
|
||||||
([`IfByMaskSize(32)`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByMaskSize))
|
|
||||||
* is not on a `down` interface
|
|
||||||
([`ExcludeIfs("flags", "down")`](https://godoc.org/github.com/hashicorp/go-sockaddr#ExcludeIfs))
|
|
||||||
* preferences an IPv6 address over an IPv4 address
|
|
||||||
([`SortIfByType()`](https://godoc.org/github.com/hashicorp/go-sockaddr#SortIfByType) +
|
|
||||||
[`ReverseIfAddrs()`](https://godoc.org/github.com/hashicorp/go-sockaddr#ReverseIfAddrs)); and
|
|
||||||
* excludes any IP in RFC6890 address
|
|
||||||
([`IfByRFC("6890")`](https://godoc.org/github.com/hashicorp/go-sockaddr#IfByRFC))
|
|
||||||
|
|
||||||
Or any combination or variation therein.
|
|
||||||
|
|
||||||
There are also a few simple helper functions such as `GetPublicIP` and
|
|
||||||
`GetPrivateIP` which both return strings and select the first public or private
|
|
||||||
IP address on the default interface, respectively. Similarly, there is also a
|
|
||||||
helper function called `GetInterfaceIP` which returns the first usable IP
|
|
||||||
address on the named interface.
|
|
||||||
|
|
||||||
## `sockaddr` CLI
|
|
||||||
|
|
||||||
Given the possible complexity of the `sockaddr` library, there is a CLI utility
|
|
||||||
that accompanies the library, also
|
|
||||||
called
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr).
|
|
||||||
The
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr)
|
|
||||||
utility exposes nearly all of the functionality of the library and can be used
|
|
||||||
either as an administrative tool or testing tool. To install
|
|
||||||
the
|
|
||||||
[`sockaddr`](https://github.com/hashicorp/go-sockaddr/tree/master/cmd/sockaddr),
|
|
||||||
run:
|
|
||||||
|
|
||||||
```text
|
|
||||||
$ go get -u github.com/hashicorp/go-sockaddr/cmd/sockaddr
|
|
||||||
```
|
|
||||||
|
|
||||||
If you're familiar with UNIX's `sockaddr` struct's, the following diagram
|
|
||||||
mapping the C `sockaddr` (top) to `go-sockaddr` structs (bottom) and
|
|
||||||
interfaces will be helpful:
|
|
||||||
|
|
||||||
```
|
|
||||||
+-------------------------------------------------------+
|
|
||||||
| |
|
|
||||||
| sockaddr |
|
|
||||||
| SockAddr |
|
|
||||||
| |
|
|
||||||
| +--------------+ +----------------------------------+ |
|
|
||||||
| | sockaddr_un | | | |
|
|
||||||
| | SockAddrUnix | | sockaddr_in{,6} | |
|
|
||||||
| +--------------+ | IPAddr | |
|
|
||||||
| | | |
|
|
||||||
| | +-------------+ +--------------+ | |
|
|
||||||
| | | sockaddr_in | | sockaddr_in6 | | |
|
|
||||||
| | | IPv4Addr | | IPv6Addr | | |
|
|
||||||
| | +-------------+ +--------------+ | |
|
|
||||||
| | | |
|
|
||||||
| +----------------------------------+ |
|
|
||||||
| |
|
|
||||||
+-------------------------------------------------------+
|
|
||||||
```
|
|
||||||
|
|
||||||
## Inspiration and Design
|
|
||||||
|
|
||||||
There were many subtle inspirations that led to this design, but the most direct
|
|
||||||
inspiration for the filtering syntax was
|
|
||||||
OpenBSD's
|
|
||||||
[`pf.conf(5)`](https://www.freebsd.org/cgi/man.cgi?query=pf.conf&apropos=0&sektion=0&arch=default&format=html#PARAMETERS) firewall
|
|
||||||
syntax that lets you select the first IP address on a given named interface.
|
|
||||||
The original problem stemmed from:
|
|
||||||
|
|
||||||
* needing to create immutable images using [Packer](https://www.packer.io) that
|
|
||||||
ran the [Consul](https://www.consul.io) process (Consul can only use one IP
|
|
||||||
address at a time);
|
|
||||||
* images that may or may not have multiple interfaces or IP addresses at
|
|
||||||
runtime; and
|
|
||||||
* we didn't want to rely on configuration management to render out the correct
|
|
||||||
IP address if the VM image was being used in an auto-scaling group.
|
|
||||||
|
|
||||||
Instead we needed some way to codify a heuristic that would correctly select the
|
|
||||||
right IP address but the input parameters were not known when the image was
|
|
||||||
created.
|
|
5
vendor/github.com/hashicorp/go-sockaddr/doc.go
generated
vendored
5
vendor/github.com/hashicorp/go-sockaddr/doc.go
generated
vendored
|
@ -1,5 +0,0 @@
|
||||||
/*
|
|
||||||
Package sockaddr is a Go implementation of the UNIX socket family data types and
|
|
||||||
related helper functions.
|
|
||||||
*/
|
|
||||||
package sockaddr
|
|
8
vendor/github.com/hashicorp/go-sockaddr/go.mod
generated
vendored
8
vendor/github.com/hashicorp/go-sockaddr/go.mod
generated
vendored
|
@ -1,8 +0,0 @@
|
||||||
module github.com/hashicorp/go-sockaddr
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/hashicorp/errwrap v1.0.0
|
|
||||||
github.com/mitchellh/cli v1.0.0
|
|
||||||
github.com/mitchellh/go-wordwrap v1.0.0
|
|
||||||
github.com/ryanuber/columnize v2.1.0+incompatible
|
|
||||||
)
|
|
24
vendor/github.com/hashicorp/go-sockaddr/go.sum
generated
vendored
24
vendor/github.com/hashicorp/go-sockaddr/go.sum
generated
vendored
|
@ -1,24 +0,0 @@
|
||||||
github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310 h1:BUAU3CGlLvorLI26FmByPp2eC2qla6E1Tw+scpcg/to=
|
|
||||||
github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
|
|
||||||
github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=
|
|
||||||
github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
|
|
||||||
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
|
|
||||||
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
|
|
||||||
github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA=
|
|
||||||
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
|
|
||||||
github.com/hashicorp/go-multierror v1.0.0 h1:iVjPR7a6H0tWELX5NxNe7bYopibicUzc7uPribsnS6o=
|
|
||||||
github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
|
|
||||||
github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
|
|
||||||
github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
|
|
||||||
github.com/mattn/go-isatty v0.0.3 h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
|
|
||||||
github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
|
|
||||||
github.com/mitchellh/cli v1.0.0 h1:iGBIsUe3+HZ/AD/Vd7DErOt5sU9fa8Uj7A2s1aggv1Y=
|
|
||||||
github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc=
|
|
||||||
github.com/mitchellh/go-wordwrap v1.0.0 h1:6GlHJ/LTGMrIJbwgdqdl2eEH8o+Exx/0m8ir9Gns0u4=
|
|
||||||
github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo=
|
|
||||||
github.com/posener/complete v1.1.1 h1:ccV59UEOTzVDnDUEFdT95ZzHVZ+5+158q8+SJb2QV5w=
|
|
||||||
github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI=
|
|
||||||
github.com/ryanuber/columnize v2.1.0+incompatible h1:j1Wcmh8OrK4Q7GXY+V7SVSY8nUWQxHW5TkBe7YUl+2s=
|
|
||||||
github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
|
|
||||||
golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc h1:MeuS1UDyZyFH++6vVy44PuufTeFF0d0nfI6XB87YGSk=
|
|
||||||
golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
|
254
vendor/github.com/hashicorp/go-sockaddr/ifaddr.go
generated
vendored
254
vendor/github.com/hashicorp/go-sockaddr/ifaddr.go
generated
vendored
|
@ -1,254 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import "strings"
|
|
||||||
|
|
||||||
// ifAddrAttrMap is a map of the IfAddr type-specific attributes.
|
|
||||||
var ifAddrAttrMap map[AttrName]func(IfAddr) string
|
|
||||||
var ifAddrAttrs []AttrName
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
ifAddrAttrInit()
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPrivateIP returns a string with a single IP address that is part of RFC
|
|
||||||
// 6890 and has a default route. If the system can't determine its IP address
|
|
||||||
// or find an RFC 6890 IP address, an empty string will be returned instead.
|
|
||||||
// This function is the `eval` equivalent of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetPrivateInterfaces | attr "address"}}'
|
|
||||||
/// ```
|
|
||||||
func GetPrivateIP() (string, error) {
|
|
||||||
privateIfs, err := GetPrivateInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if len(privateIfs) < 1 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddr := privateIfs[0]
|
|
||||||
ip := *ToIPAddr(ifAddr.SockAddr)
|
|
||||||
return ip.NetIP().String(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPrivateIPs returns a string with all IP addresses that are part of RFC
|
|
||||||
// 6890 (regardless of whether or not there is a default route, unlike
|
|
||||||
// GetPublicIP). If the system can't find any RFC 6890 IP addresses, an empty
|
|
||||||
// string will be returned instead. This function is the `eval` equivalent of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetAllInterfaces | include "RFC" "6890" | join "address" " "}}'
|
|
||||||
/// ```
|
|
||||||
func GetPrivateIPs() (string, error) {
|
|
||||||
ifAddrs, err := GetAllInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(ifAddrs) < 1 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, _ = FilterIfByType(ifAddrs, TypeIP)
|
|
||||||
if len(ifAddrs) == 0 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
OrderedIfAddrBy(AscIfType, AscIfNetworkSize).Sort(ifAddrs)
|
|
||||||
|
|
||||||
ifAddrs, _, err = IfByRFC("6890", ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(ifAddrs) == 0 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
_, ifAddrs, err = IfByRFC(ForwardingBlacklistRFC, ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(ifAddrs) == 0 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ips := make([]string, 0, len(ifAddrs))
|
|
||||||
for _, ifAddr := range ifAddrs {
|
|
||||||
ip := *ToIPAddr(ifAddr.SockAddr)
|
|
||||||
s := ip.NetIP().String()
|
|
||||||
ips = append(ips, s)
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Join(ips, " "), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPublicIP returns a string with a single IP address that is NOT part of RFC
|
|
||||||
// 6890 and has a default route. If the system can't determine its IP address
|
|
||||||
// or find a non RFC 6890 IP address, an empty string will be returned instead.
|
|
||||||
// This function is the `eval` equivalent of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetPublicInterfaces | attr "address"}}'
|
|
||||||
/// ```
|
|
||||||
func GetPublicIP() (string, error) {
|
|
||||||
publicIfs, err := GetPublicInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(publicIfs) < 1 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddr := publicIfs[0]
|
|
||||||
ip := *ToIPAddr(ifAddr.SockAddr)
|
|
||||||
return ip.NetIP().String(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPublicIPs returns a string with all IP addresses that are NOT part of RFC
|
|
||||||
// 6890 (regardless of whether or not there is a default route, unlike
|
|
||||||
// GetPublicIP). If the system can't find any non RFC 6890 IP addresses, an
|
|
||||||
// empty string will be returned instead. This function is the `eval`
|
|
||||||
// equivalent of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetAllInterfaces | exclude "RFC" "6890" | join "address" " "}}'
|
|
||||||
/// ```
|
|
||||||
func GetPublicIPs() (string, error) {
|
|
||||||
ifAddrs, err := GetAllInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(ifAddrs) < 1 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, _ = FilterIfByType(ifAddrs, TypeIP)
|
|
||||||
if len(ifAddrs) == 0 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
OrderedIfAddrBy(AscIfType, AscIfNetworkSize).Sort(ifAddrs)
|
|
||||||
|
|
||||||
_, ifAddrs, err = IfByRFC("6890", ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
} else if len(ifAddrs) == 0 {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ips := make([]string, 0, len(ifAddrs))
|
|
||||||
for _, ifAddr := range ifAddrs {
|
|
||||||
ip := *ToIPAddr(ifAddr.SockAddr)
|
|
||||||
s := ip.NetIP().String()
|
|
||||||
ips = append(ips, s)
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Join(ips, " "), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetInterfaceIP returns a string with a single IP address sorted by the size
|
|
||||||
// of the network (i.e. IP addresses with a smaller netmask, larger network
|
|
||||||
// size, are sorted first). This function is the `eval` equivalent of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetAllInterfaces | include "name" <<ARG>> | sort "type,size" | include "flag" "forwardable" | attr "address" }}'
|
|
||||||
/// ```
|
|
||||||
func GetInterfaceIP(namedIfRE string) (string, error) {
|
|
||||||
ifAddrs, err := GetAllInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, _, err = IfByName(namedIfRE, ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, _, err = IfByFlag("forwardable", ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, err = SortIfBy("+type,+size", ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(ifAddrs) == 0 {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ip := ToIPAddr(ifAddrs[0].SockAddr)
|
|
||||||
if ip == nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
return IPAddrAttr(*ip, "address"), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetInterfaceIPs returns a string with all IPs, sorted by the size of the
|
|
||||||
// network (i.e. IP addresses with a smaller netmask, larger network size, are
|
|
||||||
// sorted first), on a named interface. This function is the `eval` equivalent
|
|
||||||
// of:
|
|
||||||
//
|
|
||||||
// ```
|
|
||||||
// $ sockaddr eval -r '{{GetAllInterfaces | include "name" <<ARG>> | sort "type,size" | join "address" " "}}'
|
|
||||||
/// ```
|
|
||||||
func GetInterfaceIPs(namedIfRE string) (string, error) {
|
|
||||||
ifAddrs, err := GetAllInterfaces()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, _, err = IfByName(namedIfRE, ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrs, err = SortIfBy("+type,+size", ifAddrs)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(ifAddrs) == 0 {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ips := make([]string, 0, len(ifAddrs))
|
|
||||||
for _, ifAddr := range ifAddrs {
|
|
||||||
ip := *ToIPAddr(ifAddr.SockAddr)
|
|
||||||
s := ip.NetIP().String()
|
|
||||||
ips = append(ips, s)
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Join(ips, " "), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// IfAddrAttrs returns a list of attributes supported by the IfAddr type
|
|
||||||
func IfAddrAttrs() []AttrName {
|
|
||||||
return ifAddrAttrs
|
|
||||||
}
|
|
||||||
|
|
||||||
// IfAddrAttr returns a string representation of an attribute for the given
|
|
||||||
// IfAddr.
|
|
||||||
func IfAddrAttr(ifAddr IfAddr, attrName AttrName) string {
|
|
||||||
fn, found := ifAddrAttrMap[attrName]
|
|
||||||
if !found {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(ifAddr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ifAddrAttrInit is called once at init()
|
|
||||||
func ifAddrAttrInit() {
|
|
||||||
// Sorted for human readability
|
|
||||||
ifAddrAttrs = []AttrName{
|
|
||||||
"flags",
|
|
||||||
"name",
|
|
||||||
}
|
|
||||||
|
|
||||||
ifAddrAttrMap = map[AttrName]func(ifAddr IfAddr) string{
|
|
||||||
"flags": func(ifAddr IfAddr) string {
|
|
||||||
return ifAddr.Interface.Flags.String()
|
|
||||||
},
|
|
||||||
"name": func(ifAddr IfAddr) string {
|
|
||||||
return ifAddr.Interface.Name
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
1281
vendor/github.com/hashicorp/go-sockaddr/ifaddrs.go
generated
vendored
1281
vendor/github.com/hashicorp/go-sockaddr/ifaddrs.go
generated
vendored
File diff suppressed because it is too large
Load diff
65
vendor/github.com/hashicorp/go-sockaddr/ifattr.go
generated
vendored
65
vendor/github.com/hashicorp/go-sockaddr/ifattr.go
generated
vendored
|
@ -1,65 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
)
|
|
||||||
|
|
||||||
// IfAddr is a union of a SockAddr and a net.Interface.
|
|
||||||
type IfAddr struct {
|
|
||||||
SockAddr
|
|
||||||
net.Interface
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attr returns the named attribute as a string
|
|
||||||
func (ifAddr IfAddr) Attr(attrName AttrName) (string, error) {
|
|
||||||
val := IfAddrAttr(ifAddr, attrName)
|
|
||||||
if val != "" {
|
|
||||||
return val, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return Attr(ifAddr.SockAddr, attrName)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attr returns the named attribute as a string
|
|
||||||
func Attr(sa SockAddr, attrName AttrName) (string, error) {
|
|
||||||
switch sockType := sa.Type(); {
|
|
||||||
case sockType&TypeIP != 0:
|
|
||||||
ip := *ToIPAddr(sa)
|
|
||||||
attrVal := IPAddrAttr(ip, attrName)
|
|
||||||
if attrVal != "" {
|
|
||||||
return attrVal, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if sockType == TypeIPv4 {
|
|
||||||
ipv4 := *ToIPv4Addr(sa)
|
|
||||||
attrVal := IPv4AddrAttr(ipv4, attrName)
|
|
||||||
if attrVal != "" {
|
|
||||||
return attrVal, nil
|
|
||||||
}
|
|
||||||
} else if sockType == TypeIPv6 {
|
|
||||||
ipv6 := *ToIPv6Addr(sa)
|
|
||||||
attrVal := IPv6AddrAttr(ipv6, attrName)
|
|
||||||
if attrVal != "" {
|
|
||||||
return attrVal, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
case sockType == TypeUnix:
|
|
||||||
us := *ToUnixSock(sa)
|
|
||||||
attrVal := UnixSockAttr(us, attrName)
|
|
||||||
if attrVal != "" {
|
|
||||||
return attrVal, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Non type-specific attributes
|
|
||||||
switch attrName {
|
|
||||||
case "string":
|
|
||||||
return sa.String(), nil
|
|
||||||
case "type":
|
|
||||||
return sa.Type().String(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return "", fmt.Errorf("unsupported attribute name %q", attrName)
|
|
||||||
}
|
|
169
vendor/github.com/hashicorp/go-sockaddr/ipaddr.go
generated
vendored
169
vendor/github.com/hashicorp/go-sockaddr/ipaddr.go
generated
vendored
|
@ -1,169 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"math/big"
|
|
||||||
"net"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Constants for the sizes of IPv3, IPv4, and IPv6 address types.
|
|
||||||
const (
|
|
||||||
IPv3len = 6
|
|
||||||
IPv4len = 4
|
|
||||||
IPv6len = 16
|
|
||||||
)
|
|
||||||
|
|
||||||
// IPAddr is a generic IP address interface for IPv4 and IPv6 addresses,
|
|
||||||
// networks, and socket endpoints.
|
|
||||||
type IPAddr interface {
|
|
||||||
SockAddr
|
|
||||||
AddressBinString() string
|
|
||||||
AddressHexString() string
|
|
||||||
Cmp(SockAddr) int
|
|
||||||
CmpAddress(SockAddr) int
|
|
||||||
CmpPort(SockAddr) int
|
|
||||||
FirstUsable() IPAddr
|
|
||||||
Host() IPAddr
|
|
||||||
IPPort() IPPort
|
|
||||||
LastUsable() IPAddr
|
|
||||||
Maskbits() int
|
|
||||||
NetIP() *net.IP
|
|
||||||
NetIPMask() *net.IPMask
|
|
||||||
NetIPNet() *net.IPNet
|
|
||||||
Network() IPAddr
|
|
||||||
Octets() []int
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPPort is the type for an IP port number for the TCP and UDP IP transports.
|
|
||||||
type IPPort uint16
|
|
||||||
|
|
||||||
// IPPrefixLen is a typed integer representing the prefix length for a given
|
|
||||||
// IPAddr.
|
|
||||||
type IPPrefixLen byte
|
|
||||||
|
|
||||||
// ipAddrAttrMap is a map of the IPAddr type-specific attributes.
|
|
||||||
var ipAddrAttrMap map[AttrName]func(IPAddr) string
|
|
||||||
var ipAddrAttrs []AttrName
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
ipAddrInit()
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewIPAddr creates a new IPAddr from a string. Returns nil if the string is
|
|
||||||
// not an IPv4 or an IPv6 address.
|
|
||||||
func NewIPAddr(addr string) (IPAddr, error) {
|
|
||||||
ipv4Addr, err := NewIPv4Addr(addr)
|
|
||||||
if err == nil {
|
|
||||||
return ipv4Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6Addr, err := NewIPv6Addr(addr)
|
|
||||||
if err == nil {
|
|
||||||
return ipv6Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("invalid IPAddr %v", addr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPAddrAttr returns a string representation of an attribute for the given
|
|
||||||
// IPAddr.
|
|
||||||
func IPAddrAttr(ip IPAddr, selector AttrName) string {
|
|
||||||
fn, found := ipAddrAttrMap[selector]
|
|
||||||
if !found {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(ip)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPAttrs returns a list of attributes supported by the IPAddr type
|
|
||||||
func IPAttrs() []AttrName {
|
|
||||||
return ipAddrAttrs
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustIPAddr is a helper method that must return an IPAddr or panic on invalid
|
|
||||||
// input.
|
|
||||||
func MustIPAddr(addr string) IPAddr {
|
|
||||||
ip, err := NewIPAddr(addr)
|
|
||||||
if err != nil {
|
|
||||||
panic(fmt.Sprintf("Unable to create an IPAddr from %+q: %v", addr, err))
|
|
||||||
}
|
|
||||||
return ip
|
|
||||||
}
|
|
||||||
|
|
||||||
// ipAddrInit is called once at init()
|
|
||||||
func ipAddrInit() {
|
|
||||||
// Sorted for human readability
|
|
||||||
ipAddrAttrs = []AttrName{
|
|
||||||
"host",
|
|
||||||
"address",
|
|
||||||
"port",
|
|
||||||
"netmask",
|
|
||||||
"network",
|
|
||||||
"mask_bits",
|
|
||||||
"binary",
|
|
||||||
"hex",
|
|
||||||
"first_usable",
|
|
||||||
"last_usable",
|
|
||||||
"octets",
|
|
||||||
}
|
|
||||||
|
|
||||||
ipAddrAttrMap = map[AttrName]func(ip IPAddr) string{
|
|
||||||
"address": func(ip IPAddr) string {
|
|
||||||
return ip.NetIP().String()
|
|
||||||
},
|
|
||||||
"binary": func(ip IPAddr) string {
|
|
||||||
return ip.AddressBinString()
|
|
||||||
},
|
|
||||||
"first_usable": func(ip IPAddr) string {
|
|
||||||
return ip.FirstUsable().String()
|
|
||||||
},
|
|
||||||
"hex": func(ip IPAddr) string {
|
|
||||||
return ip.AddressHexString()
|
|
||||||
},
|
|
||||||
"host": func(ip IPAddr) string {
|
|
||||||
return ip.Host().String()
|
|
||||||
},
|
|
||||||
"last_usable": func(ip IPAddr) string {
|
|
||||||
return ip.LastUsable().String()
|
|
||||||
},
|
|
||||||
"mask_bits": func(ip IPAddr) string {
|
|
||||||
return fmt.Sprintf("%d", ip.Maskbits())
|
|
||||||
},
|
|
||||||
"netmask": func(ip IPAddr) string {
|
|
||||||
switch v := ip.(type) {
|
|
||||||
case IPv4Addr:
|
|
||||||
ipv4Mask := IPv4Addr{
|
|
||||||
Address: IPv4Address(v.Mask),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
}
|
|
||||||
return ipv4Mask.String()
|
|
||||||
case IPv6Addr:
|
|
||||||
ipv6Mask := new(big.Int)
|
|
||||||
ipv6Mask.Set(v.Mask)
|
|
||||||
ipv6MaskAddr := IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6Mask),
|
|
||||||
Mask: ipv6HostMask,
|
|
||||||
}
|
|
||||||
return ipv6MaskAddr.String()
|
|
||||||
default:
|
|
||||||
return fmt.Sprintf("<unsupported type: %T>", ip)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"network": func(ip IPAddr) string {
|
|
||||||
return ip.Network().NetIP().String()
|
|
||||||
},
|
|
||||||
"octets": func(ip IPAddr) string {
|
|
||||||
octets := ip.Octets()
|
|
||||||
octetStrs := make([]string, 0, len(octets))
|
|
||||||
for _, octet := range octets {
|
|
||||||
octetStrs = append(octetStrs, fmt.Sprintf("%d", octet))
|
|
||||||
}
|
|
||||||
return strings.Join(octetStrs, " ")
|
|
||||||
},
|
|
||||||
"port": func(ip IPAddr) string {
|
|
||||||
return fmt.Sprintf("%d", ip.IPPort())
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
98
vendor/github.com/hashicorp/go-sockaddr/ipaddrs.go
generated
vendored
98
vendor/github.com/hashicorp/go-sockaddr/ipaddrs.go
generated
vendored
|
@ -1,98 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import "bytes"
|
|
||||||
|
|
||||||
type IPAddrs []IPAddr
|
|
||||||
|
|
||||||
func (s IPAddrs) Len() int { return len(s) }
|
|
||||||
func (s IPAddrs) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
|
|
||||||
|
|
||||||
// // SortIPAddrsByCmp is a type that satisfies sort.Interface and can be used
|
|
||||||
// // by the routines in this package. The SortIPAddrsByCmp type is used to
|
|
||||||
// // sort IPAddrs by Cmp()
|
|
||||||
// type SortIPAddrsByCmp struct{ IPAddrs }
|
|
||||||
|
|
||||||
// // Less reports whether the element with index i should sort before the
|
|
||||||
// // element with index j.
|
|
||||||
// func (s SortIPAddrsByCmp) Less(i, j int) bool {
|
|
||||||
// // Sort by Type, then address, then port number.
|
|
||||||
// return Less(s.IPAddrs[i], s.IPAddrs[j])
|
|
||||||
// }
|
|
||||||
|
|
||||||
// SortIPAddrsBySpecificMaskLen is a type that satisfies sort.Interface and
|
|
||||||
// can be used by the routines in this package. The
|
|
||||||
// SortIPAddrsBySpecificMaskLen type is used to sort IPAddrs by smallest
|
|
||||||
// network (most specific to largest network).
|
|
||||||
type SortIPAddrsByNetworkSize struct{ IPAddrs }
|
|
||||||
|
|
||||||
// Less reports whether the element with index i should sort before the
|
|
||||||
// element with index j.
|
|
||||||
func (s SortIPAddrsByNetworkSize) Less(i, j int) bool {
|
|
||||||
// Sort masks with a larger binary value (i.e. fewer hosts per network
|
|
||||||
// prefix) after masks with a smaller value (larger number of hosts per
|
|
||||||
// prefix).
|
|
||||||
switch bytes.Compare([]byte(*s.IPAddrs[i].NetIPMask()), []byte(*s.IPAddrs[j].NetIPMask())) {
|
|
||||||
case 0:
|
|
||||||
// Fall through to the second test if the net.IPMasks are the
|
|
||||||
// same.
|
|
||||||
break
|
|
||||||
case 1:
|
|
||||||
return true
|
|
||||||
case -1:
|
|
||||||
return false
|
|
||||||
default:
|
|
||||||
panic("bad, m'kay?")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sort IPs based on the length (i.e. prefer IPv4 over IPv6).
|
|
||||||
iLen := len(*s.IPAddrs[i].NetIP())
|
|
||||||
jLen := len(*s.IPAddrs[j].NetIP())
|
|
||||||
if iLen != jLen {
|
|
||||||
return iLen > jLen
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sort IPs based on their network address from lowest to highest.
|
|
||||||
switch bytes.Compare(s.IPAddrs[i].NetIPNet().IP, s.IPAddrs[j].NetIPNet().IP) {
|
|
||||||
case 0:
|
|
||||||
break
|
|
||||||
case 1:
|
|
||||||
return false
|
|
||||||
case -1:
|
|
||||||
return true
|
|
||||||
default:
|
|
||||||
panic("lol wut?")
|
|
||||||
}
|
|
||||||
|
|
||||||
// If a host does not have a port set, it always sorts after hosts
|
|
||||||
// that have a port (e.g. a host with a /32 and port number is more
|
|
||||||
// specific and should sort first over a host with a /32 but no port
|
|
||||||
// set).
|
|
||||||
if s.IPAddrs[i].IPPort() == 0 || s.IPAddrs[j].IPPort() == 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return s.IPAddrs[i].IPPort() < s.IPAddrs[j].IPPort()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SortIPAddrsBySpecificMaskLen is a type that satisfies sort.Interface and
|
|
||||||
// can be used by the routines in this package. The
|
|
||||||
// SortIPAddrsBySpecificMaskLen type is used to sort IPAddrs by smallest
|
|
||||||
// network (most specific to largest network).
|
|
||||||
type SortIPAddrsBySpecificMaskLen struct{ IPAddrs }
|
|
||||||
|
|
||||||
// Less reports whether the element with index i should sort before the
|
|
||||||
// element with index j.
|
|
||||||
func (s SortIPAddrsBySpecificMaskLen) Less(i, j int) bool {
|
|
||||||
return s.IPAddrs[i].Maskbits() > s.IPAddrs[j].Maskbits()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SortIPAddrsByBroadMaskLen is a type that satisfies sort.Interface and can
|
|
||||||
// be used by the routines in this package. The SortIPAddrsByBroadMaskLen
|
|
||||||
// type is used to sort IPAddrs by largest network (i.e. largest subnets
|
|
||||||
// first).
|
|
||||||
type SortIPAddrsByBroadMaskLen struct{ IPAddrs }
|
|
||||||
|
|
||||||
// Less reports whether the element with index i should sort before the
|
|
||||||
// element with index j.
|
|
||||||
func (s SortIPAddrsByBroadMaskLen) Less(i, j int) bool {
|
|
||||||
return s.IPAddrs[i].Maskbits() < s.IPAddrs[j].Maskbits()
|
|
||||||
}
|
|
516
vendor/github.com/hashicorp/go-sockaddr/ipv4addr.go
generated
vendored
516
vendor/github.com/hashicorp/go-sockaddr/ipv4addr.go
generated
vendored
|
@ -1,516 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"regexp"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
type (
|
|
||||||
// IPv4Address is a named type representing an IPv4 address.
|
|
||||||
IPv4Address uint32
|
|
||||||
|
|
||||||
// IPv4Network is a named type representing an IPv4 network.
|
|
||||||
IPv4Network uint32
|
|
||||||
|
|
||||||
// IPv4Mask is a named type representing an IPv4 network mask.
|
|
||||||
IPv4Mask uint32
|
|
||||||
)
|
|
||||||
|
|
||||||
// IPv4HostMask is a constant represents a /32 IPv4 Address
|
|
||||||
// (i.e. 255.255.255.255).
|
|
||||||
const IPv4HostMask = IPv4Mask(0xffffffff)
|
|
||||||
|
|
||||||
// ipv4AddrAttrMap is a map of the IPv4Addr type-specific attributes.
|
|
||||||
var ipv4AddrAttrMap map[AttrName]func(IPv4Addr) string
|
|
||||||
var ipv4AddrAttrs []AttrName
|
|
||||||
var trailingHexNetmaskRE *regexp.Regexp
|
|
||||||
|
|
||||||
// IPv4Addr implements a convenience wrapper around the union of Go's
|
|
||||||
// built-in net.IP and net.IPNet types. In UNIX-speak, IPv4Addr implements
|
|
||||||
// `sockaddr` when the the address family is set to AF_INET
|
|
||||||
// (i.e. `sockaddr_in`).
|
|
||||||
type IPv4Addr struct {
|
|
||||||
IPAddr
|
|
||||||
Address IPv4Address
|
|
||||||
Mask IPv4Mask
|
|
||||||
Port IPPort
|
|
||||||
}
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
ipv4AddrInit()
|
|
||||||
trailingHexNetmaskRE = regexp.MustCompile(`/([0f]{8})$`)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewIPv4Addr creates an IPv4Addr from a string. String can be in the form
|
|
||||||
// of either an IPv4:port (e.g. `1.2.3.4:80`, in which case the mask is
|
|
||||||
// assumed to be a `/32`), an IPv4 address (e.g. `1.2.3.4`, also with a `/32`
|
|
||||||
// mask), or an IPv4 CIDR (e.g. `1.2.3.4/24`, which has its IP port
|
|
||||||
// initialized to zero). ipv4Str can not be a hostname.
|
|
||||||
//
|
|
||||||
// NOTE: Many net.*() routines will initialize and return an IPv6 address.
|
|
||||||
// To create uint32 values from net.IP, always test to make sure the address
|
|
||||||
// returned can be converted to a 4 byte array using To4().
|
|
||||||
func NewIPv4Addr(ipv4Str string) (IPv4Addr, error) {
|
|
||||||
// Strip off any bogus hex-encoded netmasks that will be mis-parsed by Go. In
|
|
||||||
// particular, clients with the Barracuda VPN client will see something like:
|
|
||||||
// `192.168.3.51/00ffffff` as their IP address.
|
|
||||||
trailingHexNetmaskRe := trailingHexNetmaskRE.Copy()
|
|
||||||
if match := trailingHexNetmaskRe.FindStringIndex(ipv4Str); match != nil {
|
|
||||||
ipv4Str = ipv4Str[:match[0]]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse as an IPv4 CIDR
|
|
||||||
ipAddr, network, err := net.ParseCIDR(ipv4Str)
|
|
||||||
if err == nil {
|
|
||||||
ipv4 := ipAddr.To4()
|
|
||||||
if ipv4 == nil {
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to convert %s to an IPv4 address", ipv4Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we see an IPv6 netmask, convert it to an IPv4 mask.
|
|
||||||
netmaskSepPos := strings.LastIndexByte(ipv4Str, '/')
|
|
||||||
if netmaskSepPos != -1 && netmaskSepPos+1 < len(ipv4Str) {
|
|
||||||
netMask, err := strconv.ParseUint(ipv4Str[netmaskSepPos+1:], 10, 8)
|
|
||||||
if err != nil {
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to convert %s to an IPv4 address: unable to parse CIDR netmask: %v", ipv4Str, err)
|
|
||||||
} else if netMask > 128 {
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to convert %s to an IPv4 address: invalid CIDR netmask", ipv4Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
if netMask >= 96 {
|
|
||||||
// Convert the IPv6 netmask to an IPv4 netmask
|
|
||||||
network.Mask = net.CIDRMask(int(netMask-96), IPv4len*8)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ipv4Addr := IPv4Addr{
|
|
||||||
Address: IPv4Address(binary.BigEndian.Uint32(ipv4)),
|
|
||||||
Mask: IPv4Mask(binary.BigEndian.Uint32(network.Mask)),
|
|
||||||
}
|
|
||||||
return ipv4Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attempt to parse ipv4Str as a /32 host with a port number.
|
|
||||||
tcpAddr, err := net.ResolveTCPAddr("tcp4", ipv4Str)
|
|
||||||
if err == nil {
|
|
||||||
ipv4 := tcpAddr.IP.To4()
|
|
||||||
if ipv4 == nil {
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to resolve %+q as an IPv4 address", ipv4Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv4Uint32 := binary.BigEndian.Uint32(ipv4)
|
|
||||||
ipv4Addr := IPv4Addr{
|
|
||||||
Address: IPv4Address(ipv4Uint32),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
Port: IPPort(tcpAddr.Port),
|
|
||||||
}
|
|
||||||
|
|
||||||
return ipv4Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse as a naked IPv4 address
|
|
||||||
ip := net.ParseIP(ipv4Str)
|
|
||||||
if ip != nil {
|
|
||||||
ipv4 := ip.To4()
|
|
||||||
if ipv4 == nil {
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to string convert %+q to an IPv4 address", ipv4Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv4Uint32 := binary.BigEndian.Uint32(ipv4)
|
|
||||||
ipv4Addr := IPv4Addr{
|
|
||||||
Address: IPv4Address(ipv4Uint32),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
}
|
|
||||||
return ipv4Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return IPv4Addr{}, fmt.Errorf("Unable to parse %+q to an IPv4 address: %v", ipv4Str, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddressBinString returns a string with the IPv4Addr's Address represented
|
|
||||||
// as a sequence of '0' and '1' characters. This method is useful for
|
|
||||||
// debugging or by operators who want to inspect an address.
|
|
||||||
func (ipv4 IPv4Addr) AddressBinString() string {
|
|
||||||
return fmt.Sprintf("%032s", strconv.FormatUint(uint64(ipv4.Address), 2))
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddressHexString returns a string with the IPv4Addr address represented as
|
|
||||||
// a sequence of hex characters. This method is useful for debugging or by
|
|
||||||
// operators who want to inspect an address.
|
|
||||||
func (ipv4 IPv4Addr) AddressHexString() string {
|
|
||||||
return fmt.Sprintf("%08s", strconv.FormatUint(uint64(ipv4.Address), 16))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Broadcast is an IPv4Addr-only method that returns the broadcast address of
|
|
||||||
// the network.
|
|
||||||
//
|
|
||||||
// NOTE: IPv6 only supports multicast, so this method only exists for
|
|
||||||
// IPv4Addr.
|
|
||||||
func (ipv4 IPv4Addr) Broadcast() IPAddr {
|
|
||||||
// Nothing should listen on a broadcast address.
|
|
||||||
return IPv4Addr{
|
|
||||||
Address: IPv4Address(ipv4.BroadcastAddress()),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// BroadcastAddress returns a IPv4Network of the IPv4Addr's broadcast
|
|
||||||
// address.
|
|
||||||
func (ipv4 IPv4Addr) BroadcastAddress() IPv4Network {
|
|
||||||
return IPv4Network(uint32(ipv4.Address)&uint32(ipv4.Mask) | ^uint32(ipv4.Mask))
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpAddress follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because its address is lower than arg
|
|
||||||
// - 0 if the SockAddr arg is equal to the receiving IPv4Addr or the argument is
|
|
||||||
// of a different type.
|
|
||||||
// - 1 If the argument should sort first.
|
|
||||||
func (ipv4 IPv4Addr) CmpAddress(sa SockAddr) int {
|
|
||||||
ipv4b, ok := sa.(IPv4Addr)
|
|
||||||
if !ok {
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case ipv4.Address == ipv4b.Address:
|
|
||||||
return sortDeferDecision
|
|
||||||
case ipv4.Address < ipv4b.Address:
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
default:
|
|
||||||
return sortArgBeforeReceiver
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpPort follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because its port is lower than arg
|
|
||||||
// - 0 if the SockAddr arg's port number is equal to the receiving IPv4Addr,
|
|
||||||
// regardless of type.
|
|
||||||
// - 1 If the argument should sort first.
|
|
||||||
func (ipv4 IPv4Addr) CmpPort(sa SockAddr) int {
|
|
||||||
var saPort IPPort
|
|
||||||
switch v := sa.(type) {
|
|
||||||
case IPv4Addr:
|
|
||||||
saPort = v.Port
|
|
||||||
case IPv6Addr:
|
|
||||||
saPort = v.Port
|
|
||||||
default:
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case ipv4.Port == saPort:
|
|
||||||
return sortDeferDecision
|
|
||||||
case ipv4.Port < saPort:
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
default:
|
|
||||||
return sortArgBeforeReceiver
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpRFC follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because it belongs to the RFC and its
|
|
||||||
// arg does not
|
|
||||||
// - 0 if the receiver and arg both belong to the same RFC or neither do.
|
|
||||||
// - 1 If the arg belongs to the RFC but receiver does not.
|
|
||||||
func (ipv4 IPv4Addr) CmpRFC(rfcNum uint, sa SockAddr) int {
|
|
||||||
recvInRFC := IsRFC(rfcNum, ipv4)
|
|
||||||
ipv4b, ok := sa.(IPv4Addr)
|
|
||||||
if !ok {
|
|
||||||
// If the receiver is part of the desired RFC and the SockAddr
|
|
||||||
// argument is not, return -1 so that the receiver sorts before
|
|
||||||
// the non-IPv4 SockAddr. Conversely, if the receiver is not
|
|
||||||
// part of the RFC, punt on sorting and leave it for the next
|
|
||||||
// sorter.
|
|
||||||
if recvInRFC {
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
} else {
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
argInRFC := IsRFC(rfcNum, ipv4b)
|
|
||||||
switch {
|
|
||||||
case (recvInRFC && argInRFC), (!recvInRFC && !argInRFC):
|
|
||||||
// If a and b both belong to the RFC, or neither belong to
|
|
||||||
// rfcNum, defer sorting to the next sorter.
|
|
||||||
return sortDeferDecision
|
|
||||||
case recvInRFC && !argInRFC:
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
default:
|
|
||||||
return sortArgBeforeReceiver
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Contains returns true if the SockAddr is contained within the receiver.
|
|
||||||
func (ipv4 IPv4Addr) Contains(sa SockAddr) bool {
|
|
||||||
ipv4b, ok := sa.(IPv4Addr)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return ipv4.ContainsNetwork(ipv4b)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsAddress returns true if the IPv4Address is contained within the
|
|
||||||
// receiver.
|
|
||||||
func (ipv4 IPv4Addr) ContainsAddress(x IPv4Address) bool {
|
|
||||||
return IPv4Address(ipv4.NetworkAddress()) <= x &&
|
|
||||||
IPv4Address(ipv4.BroadcastAddress()) >= x
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsNetwork returns true if the network from IPv4Addr is contained
|
|
||||||
// within the receiver.
|
|
||||||
func (ipv4 IPv4Addr) ContainsNetwork(x IPv4Addr) bool {
|
|
||||||
return ipv4.NetworkAddress() <= x.NetworkAddress() &&
|
|
||||||
ipv4.BroadcastAddress() >= x.BroadcastAddress()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DialPacketArgs returns the arguments required to be passed to
|
|
||||||
// net.DialUDP(). If the Mask of ipv4 is not a /32 or the Port is 0,
|
|
||||||
// DialPacketArgs() will fail. See Host() to create an IPv4Addr with its
|
|
||||||
// mask set to /32.
|
|
||||||
func (ipv4 IPv4Addr) DialPacketArgs() (network, dialArgs string) {
|
|
||||||
if ipv4.Mask != IPv4HostMask || ipv4.Port == 0 {
|
|
||||||
return "udp4", ""
|
|
||||||
}
|
|
||||||
return "udp4", fmt.Sprintf("%s:%d", ipv4.NetIP().String(), ipv4.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// DialStreamArgs returns the arguments required to be passed to
|
|
||||||
// net.DialTCP(). If the Mask of ipv4 is not a /32 or the Port is 0,
|
|
||||||
// DialStreamArgs() will fail. See Host() to create an IPv4Addr with its
|
|
||||||
// mask set to /32.
|
|
||||||
func (ipv4 IPv4Addr) DialStreamArgs() (network, dialArgs string) {
|
|
||||||
if ipv4.Mask != IPv4HostMask || ipv4.Port == 0 {
|
|
||||||
return "tcp4", ""
|
|
||||||
}
|
|
||||||
return "tcp4", fmt.Sprintf("%s:%d", ipv4.NetIP().String(), ipv4.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Equal returns true if a SockAddr is equal to the receiving IPv4Addr.
|
|
||||||
func (ipv4 IPv4Addr) Equal(sa SockAddr) bool {
|
|
||||||
ipv4b, ok := sa.(IPv4Addr)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv4.Port != ipv4b.Port {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv4.Address != ipv4b.Address {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv4.NetIPNet().String() != ipv4b.NetIPNet().String() {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// FirstUsable returns an IPv4Addr set to the first address following the
|
|
||||||
// network prefix. The first usable address in a network is normally the
|
|
||||||
// gateway and should not be used except by devices forwarding packets
|
|
||||||
// between two administratively distinct networks (i.e. a router). This
|
|
||||||
// function does not discriminate against first usable vs "first address that
|
|
||||||
// should be used." For example, FirstUsable() on "192.168.1.10/24" would
|
|
||||||
// return the address "192.168.1.1/24".
|
|
||||||
func (ipv4 IPv4Addr) FirstUsable() IPAddr {
|
|
||||||
addr := ipv4.NetworkAddress()
|
|
||||||
|
|
||||||
// If /32, return the address itself. If /31 assume a point-to-point
|
|
||||||
// link and return the lower address.
|
|
||||||
if ipv4.Maskbits() < 31 {
|
|
||||||
addr++
|
|
||||||
}
|
|
||||||
|
|
||||||
return IPv4Addr{
|
|
||||||
Address: IPv4Address(addr),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Host returns a copy of ipv4 with its mask set to /32 so that it can be
|
|
||||||
// used by DialPacketArgs(), DialStreamArgs(), ListenPacketArgs(), or
|
|
||||||
// ListenStreamArgs().
|
|
||||||
func (ipv4 IPv4Addr) Host() IPAddr {
|
|
||||||
// Nothing should listen on a broadcast address.
|
|
||||||
return IPv4Addr{
|
|
||||||
Address: ipv4.Address,
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
Port: ipv4.Port,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPPort returns the Port number attached to the IPv4Addr
|
|
||||||
func (ipv4 IPv4Addr) IPPort() IPPort {
|
|
||||||
return ipv4.Port
|
|
||||||
}
|
|
||||||
|
|
||||||
// LastUsable returns the last address before the broadcast address in a
|
|
||||||
// given network.
|
|
||||||
func (ipv4 IPv4Addr) LastUsable() IPAddr {
|
|
||||||
addr := ipv4.BroadcastAddress()
|
|
||||||
|
|
||||||
// If /32, return the address itself. If /31 assume a point-to-point
|
|
||||||
// link and return the upper address.
|
|
||||||
if ipv4.Maskbits() < 31 {
|
|
||||||
addr--
|
|
||||||
}
|
|
||||||
|
|
||||||
return IPv4Addr{
|
|
||||||
Address: IPv4Address(addr),
|
|
||||||
Mask: IPv4HostMask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListenPacketArgs returns the arguments required to be passed to
|
|
||||||
// net.ListenUDP(). If the Mask of ipv4 is not a /32, ListenPacketArgs()
|
|
||||||
// will fail. See Host() to create an IPv4Addr with its mask set to /32.
|
|
||||||
func (ipv4 IPv4Addr) ListenPacketArgs() (network, listenArgs string) {
|
|
||||||
if ipv4.Mask != IPv4HostMask {
|
|
||||||
return "udp4", ""
|
|
||||||
}
|
|
||||||
return "udp4", fmt.Sprintf("%s:%d", ipv4.NetIP().String(), ipv4.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListenStreamArgs returns the arguments required to be passed to
|
|
||||||
// net.ListenTCP(). If the Mask of ipv4 is not a /32, ListenStreamArgs()
|
|
||||||
// will fail. See Host() to create an IPv4Addr with its mask set to /32.
|
|
||||||
func (ipv4 IPv4Addr) ListenStreamArgs() (network, listenArgs string) {
|
|
||||||
if ipv4.Mask != IPv4HostMask {
|
|
||||||
return "tcp4", ""
|
|
||||||
}
|
|
||||||
return "tcp4", fmt.Sprintf("%s:%d", ipv4.NetIP().String(), ipv4.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Maskbits returns the number of network mask bits in a given IPv4Addr. For
|
|
||||||
// example, the Maskbits() of "192.168.1.1/24" would return 24.
|
|
||||||
func (ipv4 IPv4Addr) Maskbits() int {
|
|
||||||
mask := make(net.IPMask, IPv4len)
|
|
||||||
binary.BigEndian.PutUint32(mask, uint32(ipv4.Mask))
|
|
||||||
maskOnes, _ := mask.Size()
|
|
||||||
return maskOnes
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustIPv4Addr is a helper method that must return an IPv4Addr or panic on
|
|
||||||
// invalid input.
|
|
||||||
func MustIPv4Addr(addr string) IPv4Addr {
|
|
||||||
ipv4, err := NewIPv4Addr(addr)
|
|
||||||
if err != nil {
|
|
||||||
panic(fmt.Sprintf("Unable to create an IPv4Addr from %+q: %v", addr, err))
|
|
||||||
}
|
|
||||||
return ipv4
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetIP returns the address as a net.IP (address is always presized to
|
|
||||||
// IPv4).
|
|
||||||
func (ipv4 IPv4Addr) NetIP() *net.IP {
|
|
||||||
x := make(net.IP, IPv4len)
|
|
||||||
binary.BigEndian.PutUint32(x, uint32(ipv4.Address))
|
|
||||||
return &x
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetIPMask create a new net.IPMask from the IPv4Addr.
|
|
||||||
func (ipv4 IPv4Addr) NetIPMask() *net.IPMask {
|
|
||||||
ipv4Mask := net.IPMask{}
|
|
||||||
ipv4Mask = make(net.IPMask, IPv4len)
|
|
||||||
binary.BigEndian.PutUint32(ipv4Mask, uint32(ipv4.Mask))
|
|
||||||
return &ipv4Mask
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetIPNet create a new net.IPNet from the IPv4Addr.
|
|
||||||
func (ipv4 IPv4Addr) NetIPNet() *net.IPNet {
|
|
||||||
ipv4net := &net.IPNet{}
|
|
||||||
ipv4net.IP = make(net.IP, IPv4len)
|
|
||||||
binary.BigEndian.PutUint32(ipv4net.IP, uint32(ipv4.NetworkAddress()))
|
|
||||||
ipv4net.Mask = *ipv4.NetIPMask()
|
|
||||||
return ipv4net
|
|
||||||
}
|
|
||||||
|
|
||||||
// Network returns the network prefix or network address for a given network.
|
|
||||||
func (ipv4 IPv4Addr) Network() IPAddr {
|
|
||||||
return IPv4Addr{
|
|
||||||
Address: IPv4Address(ipv4.NetworkAddress()),
|
|
||||||
Mask: ipv4.Mask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetworkAddress returns an IPv4Network of the IPv4Addr's network address.
|
|
||||||
func (ipv4 IPv4Addr) NetworkAddress() IPv4Network {
|
|
||||||
return IPv4Network(uint32(ipv4.Address) & uint32(ipv4.Mask))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Octets returns a slice of the four octets in an IPv4Addr's Address. The
|
|
||||||
// order of the bytes is big endian.
|
|
||||||
func (ipv4 IPv4Addr) Octets() []int {
|
|
||||||
return []int{
|
|
||||||
int(ipv4.Address >> 24),
|
|
||||||
int((ipv4.Address >> 16) & 0xff),
|
|
||||||
int((ipv4.Address >> 8) & 0xff),
|
|
||||||
int(ipv4.Address & 0xff),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns a string representation of the IPv4Addr
|
|
||||||
func (ipv4 IPv4Addr) String() string {
|
|
||||||
if ipv4.Port != 0 {
|
|
||||||
return fmt.Sprintf("%s:%d", ipv4.NetIP().String(), ipv4.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv4.Maskbits() == 32 {
|
|
||||||
return ipv4.NetIP().String()
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf("%s/%d", ipv4.NetIP().String(), ipv4.Maskbits())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Type is used as a type switch and returns TypeIPv4
|
|
||||||
func (IPv4Addr) Type() SockAddrType {
|
|
||||||
return TypeIPv4
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPv4AddrAttr returns a string representation of an attribute for the given
|
|
||||||
// IPv4Addr.
|
|
||||||
func IPv4AddrAttr(ipv4 IPv4Addr, selector AttrName) string {
|
|
||||||
fn, found := ipv4AddrAttrMap[selector]
|
|
||||||
if !found {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(ipv4)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPv4Attrs returns a list of attributes supported by the IPv4Addr type
|
|
||||||
func IPv4Attrs() []AttrName {
|
|
||||||
return ipv4AddrAttrs
|
|
||||||
}
|
|
||||||
|
|
||||||
// ipv4AddrInit is called once at init()
|
|
||||||
func ipv4AddrInit() {
|
|
||||||
// Sorted for human readability
|
|
||||||
ipv4AddrAttrs = []AttrName{
|
|
||||||
"size", // Same position as in IPv6 for output consistency
|
|
||||||
"broadcast",
|
|
||||||
"uint32",
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv4AddrAttrMap = map[AttrName]func(ipv4 IPv4Addr) string{
|
|
||||||
"broadcast": func(ipv4 IPv4Addr) string {
|
|
||||||
return ipv4.Broadcast().String()
|
|
||||||
},
|
|
||||||
"size": func(ipv4 IPv4Addr) string {
|
|
||||||
return fmt.Sprintf("%d", 1<<uint(IPv4len*8-ipv4.Maskbits()))
|
|
||||||
},
|
|
||||||
"uint32": func(ipv4 IPv4Addr) string {
|
|
||||||
return fmt.Sprintf("%d", uint32(ipv4.Address))
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
591
vendor/github.com/hashicorp/go-sockaddr/ipv6addr.go
generated
vendored
591
vendor/github.com/hashicorp/go-sockaddr/ipv6addr.go
generated
vendored
|
@ -1,591 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/binary"
|
|
||||||
"fmt"
|
|
||||||
"math/big"
|
|
||||||
"net"
|
|
||||||
)
|
|
||||||
|
|
||||||
type (
|
|
||||||
// IPv6Address is a named type representing an IPv6 address.
|
|
||||||
IPv6Address *big.Int
|
|
||||||
|
|
||||||
// IPv6Network is a named type representing an IPv6 network.
|
|
||||||
IPv6Network *big.Int
|
|
||||||
|
|
||||||
// IPv6Mask is a named type representing an IPv6 network mask.
|
|
||||||
IPv6Mask *big.Int
|
|
||||||
)
|
|
||||||
|
|
||||||
// IPv6HostPrefix is a constant represents a /128 IPv6 Prefix.
|
|
||||||
const IPv6HostPrefix = IPPrefixLen(128)
|
|
||||||
|
|
||||||
// ipv6HostMask is an unexported big.Int representing a /128 IPv6 address.
|
|
||||||
// This value must be a constant and always set to all ones.
|
|
||||||
var ipv6HostMask IPv6Mask
|
|
||||||
|
|
||||||
// ipv6AddrAttrMap is a map of the IPv6Addr type-specific attributes.
|
|
||||||
var ipv6AddrAttrMap map[AttrName]func(IPv6Addr) string
|
|
||||||
var ipv6AddrAttrs []AttrName
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
biMask := new(big.Int)
|
|
||||||
biMask.SetBytes([]byte{
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
0xff, 0xff,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
ipv6HostMask = IPv6Mask(biMask)
|
|
||||||
|
|
||||||
ipv6AddrInit()
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPv6Addr implements a convenience wrapper around the union of Go's
|
|
||||||
// built-in net.IP and net.IPNet types. In UNIX-speak, IPv6Addr implements
|
|
||||||
// `sockaddr` when the the address family is set to AF_INET6
|
|
||||||
// (i.e. `sockaddr_in6`).
|
|
||||||
type IPv6Addr struct {
|
|
||||||
IPAddr
|
|
||||||
Address IPv6Address
|
|
||||||
Mask IPv6Mask
|
|
||||||
Port IPPort
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewIPv6Addr creates an IPv6Addr from a string. String can be in the form of
|
|
||||||
// an an IPv6:port (e.g. `[2001:4860:0:2001::68]:80`, in which case the mask is
|
|
||||||
// assumed to be a /128), an IPv6 address (e.g. `2001:4860:0:2001::68`, also
|
|
||||||
// with a `/128` mask), an IPv6 CIDR (e.g. `2001:4860:0:2001::68/64`, which has
|
|
||||||
// its IP port initialized to zero). ipv6Str can not be a hostname.
|
|
||||||
//
|
|
||||||
// NOTE: Many net.*() routines will initialize and return an IPv4 address.
|
|
||||||
// Always test to make sure the address returned cannot be converted to a 4 byte
|
|
||||||
// array using To4().
|
|
||||||
func NewIPv6Addr(ipv6Str string) (IPv6Addr, error) {
|
|
||||||
v6Addr := false
|
|
||||||
LOOP:
|
|
||||||
for i := 0; i < len(ipv6Str); i++ {
|
|
||||||
switch ipv6Str[i] {
|
|
||||||
case '.':
|
|
||||||
break LOOP
|
|
||||||
case ':':
|
|
||||||
v6Addr = true
|
|
||||||
break LOOP
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !v6Addr {
|
|
||||||
return IPv6Addr{}, fmt.Errorf("Unable to resolve %+q as an IPv6 address, appears to be an IPv4 address", ipv6Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attempt to parse ipv6Str as a /128 host with a port number.
|
|
||||||
tcpAddr, err := net.ResolveTCPAddr("tcp6", ipv6Str)
|
|
||||||
if err == nil {
|
|
||||||
ipv6 := tcpAddr.IP.To16()
|
|
||||||
if ipv6 == nil {
|
|
||||||
return IPv6Addr{}, fmt.Errorf("Unable to resolve %+q as a 16byte IPv6 address", ipv6Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6BigIntAddr := new(big.Int)
|
|
||||||
ipv6BigIntAddr.SetBytes(ipv6)
|
|
||||||
|
|
||||||
ipv6BigIntMask := new(big.Int)
|
|
||||||
ipv6BigIntMask.Set(ipv6HostMask)
|
|
||||||
|
|
||||||
ipv6Addr := IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6BigIntAddr),
|
|
||||||
Mask: IPv6Mask(ipv6BigIntMask),
|
|
||||||
Port: IPPort(tcpAddr.Port),
|
|
||||||
}
|
|
||||||
|
|
||||||
return ipv6Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse as a naked IPv6 address. Trim square brackets if present.
|
|
||||||
if len(ipv6Str) > 2 && ipv6Str[0] == '[' && ipv6Str[len(ipv6Str)-1] == ']' {
|
|
||||||
ipv6Str = ipv6Str[1 : len(ipv6Str)-1]
|
|
||||||
}
|
|
||||||
ip := net.ParseIP(ipv6Str)
|
|
||||||
if ip != nil {
|
|
||||||
ipv6 := ip.To16()
|
|
||||||
if ipv6 == nil {
|
|
||||||
return IPv6Addr{}, fmt.Errorf("Unable to string convert %+q to a 16byte IPv6 address", ipv6Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6BigIntAddr := new(big.Int)
|
|
||||||
ipv6BigIntAddr.SetBytes(ipv6)
|
|
||||||
|
|
||||||
ipv6BigIntMask := new(big.Int)
|
|
||||||
ipv6BigIntMask.Set(ipv6HostMask)
|
|
||||||
|
|
||||||
return IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6BigIntAddr),
|
|
||||||
Mask: IPv6Mask(ipv6BigIntMask),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse as an IPv6 CIDR
|
|
||||||
ipAddr, network, err := net.ParseCIDR(ipv6Str)
|
|
||||||
if err == nil {
|
|
||||||
ipv6 := ipAddr.To16()
|
|
||||||
if ipv6 == nil {
|
|
||||||
return IPv6Addr{}, fmt.Errorf("Unable to convert %+q to a 16byte IPv6 address", ipv6Str)
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6BigIntAddr := new(big.Int)
|
|
||||||
ipv6BigIntAddr.SetBytes(ipv6)
|
|
||||||
|
|
||||||
ipv6BigIntMask := new(big.Int)
|
|
||||||
ipv6BigIntMask.SetBytes(network.Mask)
|
|
||||||
|
|
||||||
ipv6Addr := IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6BigIntAddr),
|
|
||||||
Mask: IPv6Mask(ipv6BigIntMask),
|
|
||||||
}
|
|
||||||
return ipv6Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return IPv6Addr{}, fmt.Errorf("Unable to parse %+q to an IPv6 address: %v", ipv6Str, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddressBinString returns a string with the IPv6Addr's Address represented
|
|
||||||
// as a sequence of '0' and '1' characters. This method is useful for
|
|
||||||
// debugging or by operators who want to inspect an address.
|
|
||||||
func (ipv6 IPv6Addr) AddressBinString() string {
|
|
||||||
bi := big.Int(*ipv6.Address)
|
|
||||||
return fmt.Sprintf("%0128s", bi.Text(2))
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddressHexString returns a string with the IPv6Addr address represented as
|
|
||||||
// a sequence of hex characters. This method is useful for debugging or by
|
|
||||||
// operators who want to inspect an address.
|
|
||||||
func (ipv6 IPv6Addr) AddressHexString() string {
|
|
||||||
bi := big.Int(*ipv6.Address)
|
|
||||||
return fmt.Sprintf("%032s", bi.Text(16))
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpAddress follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because its address is lower than arg
|
|
||||||
// - 0 if the SockAddr arg equal to the receiving IPv6Addr or the argument is of a
|
|
||||||
// different type.
|
|
||||||
// - 1 If the argument should sort first.
|
|
||||||
func (ipv6 IPv6Addr) CmpAddress(sa SockAddr) int {
|
|
||||||
ipv6b, ok := sa.(IPv6Addr)
|
|
||||||
if !ok {
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6aBigInt := new(big.Int)
|
|
||||||
ipv6aBigInt.Set(ipv6.Address)
|
|
||||||
ipv6bBigInt := new(big.Int)
|
|
||||||
ipv6bBigInt.Set(ipv6b.Address)
|
|
||||||
|
|
||||||
return ipv6aBigInt.Cmp(ipv6bBigInt)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpPort follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because its port is lower than arg
|
|
||||||
// - 0 if the SockAddr arg's port number is equal to the receiving IPv6Addr,
|
|
||||||
// regardless of type.
|
|
||||||
// - 1 If the argument should sort first.
|
|
||||||
func (ipv6 IPv6Addr) CmpPort(sa SockAddr) int {
|
|
||||||
var saPort IPPort
|
|
||||||
switch v := sa.(type) {
|
|
||||||
case IPv4Addr:
|
|
||||||
saPort = v.Port
|
|
||||||
case IPv6Addr:
|
|
||||||
saPort = v.Port
|
|
||||||
default:
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case ipv6.Port == saPort:
|
|
||||||
return sortDeferDecision
|
|
||||||
case ipv6.Port < saPort:
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
default:
|
|
||||||
return sortArgBeforeReceiver
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CmpRFC follows the Cmp() standard protocol and returns:
|
|
||||||
//
|
|
||||||
// - -1 If the receiver should sort first because it belongs to the RFC and its
|
|
||||||
// arg does not
|
|
||||||
// - 0 if the receiver and arg both belong to the same RFC or neither do.
|
|
||||||
// - 1 If the arg belongs to the RFC but receiver does not.
|
|
||||||
func (ipv6 IPv6Addr) CmpRFC(rfcNum uint, sa SockAddr) int {
|
|
||||||
recvInRFC := IsRFC(rfcNum, ipv6)
|
|
||||||
ipv6b, ok := sa.(IPv6Addr)
|
|
||||||
if !ok {
|
|
||||||
// If the receiver is part of the desired RFC and the SockAddr
|
|
||||||
// argument is not, sort receiver before the non-IPv6 SockAddr.
|
|
||||||
// Conversely, if the receiver is not part of the RFC, punt on
|
|
||||||
// sorting and leave it for the next sorter.
|
|
||||||
if recvInRFC {
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
} else {
|
|
||||||
return sortDeferDecision
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
argInRFC := IsRFC(rfcNum, ipv6b)
|
|
||||||
switch {
|
|
||||||
case (recvInRFC && argInRFC), (!recvInRFC && !argInRFC):
|
|
||||||
// If a and b both belong to the RFC, or neither belong to
|
|
||||||
// rfcNum, defer sorting to the next sorter.
|
|
||||||
return sortDeferDecision
|
|
||||||
case recvInRFC && !argInRFC:
|
|
||||||
return sortReceiverBeforeArg
|
|
||||||
default:
|
|
||||||
return sortArgBeforeReceiver
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Contains returns true if the SockAddr is contained within the receiver.
|
|
||||||
func (ipv6 IPv6Addr) Contains(sa SockAddr) bool {
|
|
||||||
ipv6b, ok := sa.(IPv6Addr)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return ipv6.ContainsNetwork(ipv6b)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsAddress returns true if the IPv6Address is contained within the
|
|
||||||
// receiver.
|
|
||||||
func (ipv6 IPv6Addr) ContainsAddress(x IPv6Address) bool {
|
|
||||||
xAddr := IPv6Addr{
|
|
||||||
Address: x,
|
|
||||||
Mask: ipv6HostMask,
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
xIPv6 := xAddr.FirstUsable().(IPv6Addr)
|
|
||||||
yIPv6 := ipv6.FirstUsable().(IPv6Addr)
|
|
||||||
if xIPv6.CmpAddress(yIPv6) >= 1 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
xIPv6 := xAddr.LastUsable().(IPv6Addr)
|
|
||||||
yIPv6 := ipv6.LastUsable().(IPv6Addr)
|
|
||||||
if xIPv6.CmpAddress(yIPv6) <= -1 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsNetwork returns true if the network from IPv6Addr is contained within
|
|
||||||
// the receiver.
|
|
||||||
func (x IPv6Addr) ContainsNetwork(y IPv6Addr) bool {
|
|
||||||
{
|
|
||||||
xIPv6 := x.FirstUsable().(IPv6Addr)
|
|
||||||
yIPv6 := y.FirstUsable().(IPv6Addr)
|
|
||||||
if ret := xIPv6.CmpAddress(yIPv6); ret >= 1 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
xIPv6 := x.LastUsable().(IPv6Addr)
|
|
||||||
yIPv6 := y.LastUsable().(IPv6Addr)
|
|
||||||
if ret := xIPv6.CmpAddress(yIPv6); ret <= -1 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// DialPacketArgs returns the arguments required to be passed to
|
|
||||||
// net.DialUDP(). If the Mask of ipv6 is not a /128 or the Port is 0,
|
|
||||||
// DialPacketArgs() will fail. See Host() to create an IPv6Addr with its
|
|
||||||
// mask set to /128.
|
|
||||||
func (ipv6 IPv6Addr) DialPacketArgs() (network, dialArgs string) {
|
|
||||||
ipv6Mask := big.Int(*ipv6.Mask)
|
|
||||||
if ipv6Mask.Cmp(ipv6HostMask) != 0 || ipv6.Port == 0 {
|
|
||||||
return "udp6", ""
|
|
||||||
}
|
|
||||||
return "udp6", fmt.Sprintf("[%s]:%d", ipv6.NetIP().String(), ipv6.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// DialStreamArgs returns the arguments required to be passed to
|
|
||||||
// net.DialTCP(). If the Mask of ipv6 is not a /128 or the Port is 0,
|
|
||||||
// DialStreamArgs() will fail. See Host() to create an IPv6Addr with its
|
|
||||||
// mask set to /128.
|
|
||||||
func (ipv6 IPv6Addr) DialStreamArgs() (network, dialArgs string) {
|
|
||||||
ipv6Mask := big.Int(*ipv6.Mask)
|
|
||||||
if ipv6Mask.Cmp(ipv6HostMask) != 0 || ipv6.Port == 0 {
|
|
||||||
return "tcp6", ""
|
|
||||||
}
|
|
||||||
return "tcp6", fmt.Sprintf("[%s]:%d", ipv6.NetIP().String(), ipv6.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Equal returns true if a SockAddr is equal to the receiving IPv4Addr.
|
|
||||||
func (ipv6a IPv6Addr) Equal(sa SockAddr) bool {
|
|
||||||
ipv6b, ok := sa.(IPv6Addr)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv6a.NetIP().String() != ipv6b.NetIP().String() {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv6a.NetIPNet().String() != ipv6b.NetIPNet().String() {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv6a.Port != ipv6b.Port {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// FirstUsable returns an IPv6Addr set to the first address following the
|
|
||||||
// network prefix. The first usable address in a network is normally the
|
|
||||||
// gateway and should not be used except by devices forwarding packets
|
|
||||||
// between two administratively distinct networks (i.e. a router). This
|
|
||||||
// function does not discriminate against first usable vs "first address that
|
|
||||||
// should be used." For example, FirstUsable() on "2001:0db8::0003/64" would
|
|
||||||
// return "2001:0db8::00011".
|
|
||||||
func (ipv6 IPv6Addr) FirstUsable() IPAddr {
|
|
||||||
return IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6.NetworkAddress()),
|
|
||||||
Mask: ipv6HostMask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Host returns a copy of ipv6 with its mask set to /128 so that it can be
|
|
||||||
// used by DialPacketArgs(), DialStreamArgs(), ListenPacketArgs(), or
|
|
||||||
// ListenStreamArgs().
|
|
||||||
func (ipv6 IPv6Addr) Host() IPAddr {
|
|
||||||
// Nothing should listen on a broadcast address.
|
|
||||||
return IPv6Addr{
|
|
||||||
Address: ipv6.Address,
|
|
||||||
Mask: ipv6HostMask,
|
|
||||||
Port: ipv6.Port,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPPort returns the Port number attached to the IPv6Addr
|
|
||||||
func (ipv6 IPv6Addr) IPPort() IPPort {
|
|
||||||
return ipv6.Port
|
|
||||||
}
|
|
||||||
|
|
||||||
// LastUsable returns the last address in a given network.
|
|
||||||
func (ipv6 IPv6Addr) LastUsable() IPAddr {
|
|
||||||
addr := new(big.Int)
|
|
||||||
addr.Set(ipv6.Address)
|
|
||||||
|
|
||||||
mask := new(big.Int)
|
|
||||||
mask.Set(ipv6.Mask)
|
|
||||||
|
|
||||||
negMask := new(big.Int)
|
|
||||||
negMask.Xor(ipv6HostMask, mask)
|
|
||||||
|
|
||||||
lastAddr := new(big.Int)
|
|
||||||
lastAddr.And(addr, mask)
|
|
||||||
lastAddr.Or(lastAddr, negMask)
|
|
||||||
|
|
||||||
return IPv6Addr{
|
|
||||||
Address: IPv6Address(lastAddr),
|
|
||||||
Mask: ipv6HostMask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListenPacketArgs returns the arguments required to be passed to
|
|
||||||
// net.ListenUDP(). If the Mask of ipv6 is not a /128, ListenPacketArgs()
|
|
||||||
// will fail. See Host() to create an IPv6Addr with its mask set to /128.
|
|
||||||
func (ipv6 IPv6Addr) ListenPacketArgs() (network, listenArgs string) {
|
|
||||||
ipv6Mask := big.Int(*ipv6.Mask)
|
|
||||||
if ipv6Mask.Cmp(ipv6HostMask) != 0 {
|
|
||||||
return "udp6", ""
|
|
||||||
}
|
|
||||||
return "udp6", fmt.Sprintf("[%s]:%d", ipv6.NetIP().String(), ipv6.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListenStreamArgs returns the arguments required to be passed to
|
|
||||||
// net.ListenTCP(). If the Mask of ipv6 is not a /128, ListenStreamArgs()
|
|
||||||
// will fail. See Host() to create an IPv6Addr with its mask set to /128.
|
|
||||||
func (ipv6 IPv6Addr) ListenStreamArgs() (network, listenArgs string) {
|
|
||||||
ipv6Mask := big.Int(*ipv6.Mask)
|
|
||||||
if ipv6Mask.Cmp(ipv6HostMask) != 0 {
|
|
||||||
return "tcp6", ""
|
|
||||||
}
|
|
||||||
return "tcp6", fmt.Sprintf("[%s]:%d", ipv6.NetIP().String(), ipv6.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Maskbits returns the number of network mask bits in a given IPv6Addr. For
|
|
||||||
// example, the Maskbits() of "2001:0db8::0003/64" would return 64.
|
|
||||||
func (ipv6 IPv6Addr) Maskbits() int {
|
|
||||||
maskOnes, _ := ipv6.NetIPNet().Mask.Size()
|
|
||||||
|
|
||||||
return maskOnes
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustIPv6Addr is a helper method that must return an IPv6Addr or panic on
|
|
||||||
// invalid input.
|
|
||||||
func MustIPv6Addr(addr string) IPv6Addr {
|
|
||||||
ipv6, err := NewIPv6Addr(addr)
|
|
||||||
if err != nil {
|
|
||||||
panic(fmt.Sprintf("Unable to create an IPv6Addr from %+q: %v", addr, err))
|
|
||||||
}
|
|
||||||
return ipv6
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetIP returns the address as a net.IP.
|
|
||||||
func (ipv6 IPv6Addr) NetIP() *net.IP {
|
|
||||||
return bigIntToNetIPv6(ipv6.Address)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetIPMask create a new net.IPMask from the IPv6Addr.
|
|
||||||
func (ipv6 IPv6Addr) NetIPMask() *net.IPMask {
|
|
||||||
ipv6Mask := make(net.IPMask, IPv6len)
|
|
||||||
m := big.Int(*ipv6.Mask)
|
|
||||||
copy(ipv6Mask, m.Bytes())
|
|
||||||
return &ipv6Mask
|
|
||||||
}
|
|
||||||
|
|
||||||
// Network returns a pointer to the net.IPNet within IPv4Addr receiver.
|
|
||||||
func (ipv6 IPv6Addr) NetIPNet() *net.IPNet {
|
|
||||||
ipv6net := &net.IPNet{}
|
|
||||||
ipv6net.IP = make(net.IP, IPv6len)
|
|
||||||
copy(ipv6net.IP, *ipv6.NetIP())
|
|
||||||
ipv6net.Mask = *ipv6.NetIPMask()
|
|
||||||
return ipv6net
|
|
||||||
}
|
|
||||||
|
|
||||||
// Network returns the network prefix or network address for a given network.
|
|
||||||
func (ipv6 IPv6Addr) Network() IPAddr {
|
|
||||||
return IPv6Addr{
|
|
||||||
Address: IPv6Address(ipv6.NetworkAddress()),
|
|
||||||
Mask: ipv6.Mask,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetworkAddress returns an IPv6Network of the IPv6Addr's network address.
|
|
||||||
func (ipv6 IPv6Addr) NetworkAddress() IPv6Network {
|
|
||||||
addr := new(big.Int)
|
|
||||||
addr.SetBytes((*ipv6.Address).Bytes())
|
|
||||||
|
|
||||||
mask := new(big.Int)
|
|
||||||
mask.SetBytes(*ipv6.NetIPMask())
|
|
||||||
|
|
||||||
netAddr := new(big.Int)
|
|
||||||
netAddr.And(addr, mask)
|
|
||||||
|
|
||||||
return IPv6Network(netAddr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Octets returns a slice of the 16 octets in an IPv6Addr's Address. The
|
|
||||||
// order of the bytes is big endian.
|
|
||||||
func (ipv6 IPv6Addr) Octets() []int {
|
|
||||||
x := make([]int, IPv6len)
|
|
||||||
for i, b := range *bigIntToNetIPv6(ipv6.Address) {
|
|
||||||
x[i] = int(b)
|
|
||||||
}
|
|
||||||
|
|
||||||
return x
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns a string representation of the IPv6Addr
|
|
||||||
func (ipv6 IPv6Addr) String() string {
|
|
||||||
if ipv6.Port != 0 {
|
|
||||||
return fmt.Sprintf("[%s]:%d", ipv6.NetIP().String(), ipv6.Port)
|
|
||||||
}
|
|
||||||
|
|
||||||
if ipv6.Maskbits() == 128 {
|
|
||||||
return ipv6.NetIP().String()
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf("%s/%d", ipv6.NetIP().String(), ipv6.Maskbits())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Type is used as a type switch and returns TypeIPv6
|
|
||||||
func (IPv6Addr) Type() SockAddrType {
|
|
||||||
return TypeIPv6
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPv6Attrs returns a list of attributes supported by the IPv6Addr type
|
|
||||||
func IPv6Attrs() []AttrName {
|
|
||||||
return ipv6AddrAttrs
|
|
||||||
}
|
|
||||||
|
|
||||||
// IPv6AddrAttr returns a string representation of an attribute for the given
|
|
||||||
// IPv6Addr.
|
|
||||||
func IPv6AddrAttr(ipv6 IPv6Addr, selector AttrName) string {
|
|
||||||
fn, found := ipv6AddrAttrMap[selector]
|
|
||||||
if !found {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(ipv6)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ipv6AddrInit is called once at init()
|
|
||||||
func ipv6AddrInit() {
|
|
||||||
// Sorted for human readability
|
|
||||||
ipv6AddrAttrs = []AttrName{
|
|
||||||
"size", // Same position as in IPv6 for output consistency
|
|
||||||
"uint128",
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6AddrAttrMap = map[AttrName]func(ipv6 IPv6Addr) string{
|
|
||||||
"size": func(ipv6 IPv6Addr) string {
|
|
||||||
netSize := big.NewInt(1)
|
|
||||||
netSize = netSize.Lsh(netSize, uint(IPv6len*8-ipv6.Maskbits()))
|
|
||||||
return netSize.Text(10)
|
|
||||||
},
|
|
||||||
"uint128": func(ipv6 IPv6Addr) string {
|
|
||||||
b := big.Int(*ipv6.Address)
|
|
||||||
return b.Text(10)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// bigIntToNetIPv6 is a helper function that correctly returns a net.IP with the
|
|
||||||
// correctly padded values.
|
|
||||||
func bigIntToNetIPv6(bi *big.Int) *net.IP {
|
|
||||||
x := make(net.IP, IPv6len)
|
|
||||||
ipv6Bytes := bi.Bytes()
|
|
||||||
|
|
||||||
// It's possibe for ipv6Bytes to be less than IPv6len bytes in size. If
|
|
||||||
// they are different sizes we to pad the size of response.
|
|
||||||
if len(ipv6Bytes) < IPv6len {
|
|
||||||
buf := new(bytes.Buffer)
|
|
||||||
buf.Grow(IPv6len)
|
|
||||||
|
|
||||||
for i := len(ipv6Bytes); i < IPv6len; i++ {
|
|
||||||
if err := binary.Write(buf, binary.BigEndian, byte(0)); err != nil {
|
|
||||||
panic(fmt.Sprintf("Unable to pad byte %d of input %v: %v", i, bi, err))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, b := range ipv6Bytes {
|
|
||||||
if err := binary.Write(buf, binary.BigEndian, b); err != nil {
|
|
||||||
panic(fmt.Sprintf("Unable to preserve endianness of input %v: %v", bi, err))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6Bytes = buf.Bytes()
|
|
||||||
}
|
|
||||||
i := copy(x, ipv6Bytes)
|
|
||||||
if i != IPv6len {
|
|
||||||
panic("IPv6 wrong size")
|
|
||||||
}
|
|
||||||
return &x
|
|
||||||
}
|
|
948
vendor/github.com/hashicorp/go-sockaddr/rfc.go
generated
vendored
948
vendor/github.com/hashicorp/go-sockaddr/rfc.go
generated
vendored
|
@ -1,948 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
// ForwardingBlacklist is a faux RFC that includes a list of non-forwardable IP
|
|
||||||
// blocks.
|
|
||||||
const ForwardingBlacklist = 4294967295
|
|
||||||
const ForwardingBlacklistRFC = "4294967295"
|
|
||||||
|
|
||||||
// IsRFC tests to see if an SockAddr matches the specified RFC
|
|
||||||
func IsRFC(rfcNum uint, sa SockAddr) bool {
|
|
||||||
rfcNetMap := KnownRFCs()
|
|
||||||
rfcNets, ok := rfcNetMap[rfcNum]
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
var contained bool
|
|
||||||
for _, rfcNet := range rfcNets {
|
|
||||||
if rfcNet.Contains(sa) {
|
|
||||||
contained = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return contained
|
|
||||||
}
|
|
||||||
|
|
||||||
// KnownRFCs returns an initial set of known RFCs.
|
|
||||||
//
|
|
||||||
// NOTE (sean@): As this list evolves over time, please submit patches to keep
|
|
||||||
// this list current. If something isn't right, inquire, as it may just be a
|
|
||||||
// bug on my part. Some of the inclusions were based on my judgement as to what
|
|
||||||
// would be a useful value (e.g. RFC3330).
|
|
||||||
//
|
|
||||||
// Useful resources:
|
|
||||||
//
|
|
||||||
// * https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
|
|
||||||
// * https://www.iana.org/assignments/ipv6-unicast-address-assignments/ipv6-unicast-address-assignments.xhtml
|
|
||||||
// * https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
|
|
||||||
func KnownRFCs() map[uint]SockAddrs {
|
|
||||||
// NOTE(sean@): Multiple SockAddrs per RFC lend themselves well to a
|
|
||||||
// RADIX tree, but `ENOTIME`. Patches welcome.
|
|
||||||
return map[uint]SockAddrs{
|
|
||||||
919: {
|
|
||||||
// [RFC919] Broadcasting Internet Datagrams
|
|
||||||
MustIPv4Addr("255.255.255.255/32"), // [RFC1122], §7 Broadcast IP Addressing - Proposed Standards
|
|
||||||
},
|
|
||||||
1122: {
|
|
||||||
// [RFC1122] Requirements for Internet Hosts -- Communication Layers
|
|
||||||
MustIPv4Addr("0.0.0.0/8"), // [RFC1122], §3.2.1.3
|
|
||||||
MustIPv4Addr("127.0.0.0/8"), // [RFC1122], §3.2.1.3
|
|
||||||
},
|
|
||||||
1112: {
|
|
||||||
// [RFC1112] Host Extensions for IP Multicasting
|
|
||||||
MustIPv4Addr("224.0.0.0/4"), // [RFC1112], §4 Host Group Addresses
|
|
||||||
},
|
|
||||||
1918: {
|
|
||||||
// [RFC1918] Address Allocation for Private Internets
|
|
||||||
MustIPv4Addr("10.0.0.0/8"),
|
|
||||||
MustIPv4Addr("172.16.0.0/12"),
|
|
||||||
MustIPv4Addr("192.168.0.0/16"),
|
|
||||||
},
|
|
||||||
2544: {
|
|
||||||
// [RFC2544] Benchmarking Methodology for Network
|
|
||||||
// Interconnect Devices
|
|
||||||
MustIPv4Addr("198.18.0.0/15"),
|
|
||||||
},
|
|
||||||
2765: {
|
|
||||||
// [RFC2765] Stateless IP/ICMP Translation Algorithm
|
|
||||||
// (SIIT) (obsoleted by RFCs 6145, which itself was
|
|
||||||
// later obsoleted by 7915).
|
|
||||||
|
|
||||||
// [RFC2765], §2.1 Addresses
|
|
||||||
MustIPv6Addr("0:0:0:0:0:ffff:0:0/96"),
|
|
||||||
},
|
|
||||||
2928: {
|
|
||||||
// [RFC2928] Initial IPv6 Sub-TLA ID Assignments
|
|
||||||
MustIPv6Addr("2001::/16"), // Superblock
|
|
||||||
//MustIPv6Addr("2001:0000::/23"), // IANA
|
|
||||||
//MustIPv6Addr("2001:0200::/23"), // APNIC
|
|
||||||
//MustIPv6Addr("2001:0400::/23"), // ARIN
|
|
||||||
//MustIPv6Addr("2001:0600::/23"), // RIPE NCC
|
|
||||||
//MustIPv6Addr("2001:0800::/23"), // (future assignment)
|
|
||||||
// ...
|
|
||||||
//MustIPv6Addr("2001:FE00::/23"), // (future assignment)
|
|
||||||
},
|
|
||||||
3056: { // 6to4 address
|
|
||||||
// [RFC3056] Connection of IPv6 Domains via IPv4 Clouds
|
|
||||||
|
|
||||||
// [RFC3056], §2 IPv6 Prefix Allocation
|
|
||||||
MustIPv6Addr("2002::/16"),
|
|
||||||
},
|
|
||||||
3068: {
|
|
||||||
// [RFC3068] An Anycast Prefix for 6to4 Relay Routers
|
|
||||||
// (obsolete by RFC7526)
|
|
||||||
|
|
||||||
// [RFC3068], § 6to4 Relay anycast address
|
|
||||||
MustIPv4Addr("192.88.99.0/24"),
|
|
||||||
|
|
||||||
// [RFC3068], §2.5 6to4 IPv6 relay anycast address
|
|
||||||
//
|
|
||||||
// NOTE: /120 == 128-(32-24)
|
|
||||||
MustIPv6Addr("2002:c058:6301::/120"),
|
|
||||||
},
|
|
||||||
3171: {
|
|
||||||
// [RFC3171] IANA Guidelines for IPv4 Multicast Address Assignments
|
|
||||||
MustIPv4Addr("224.0.0.0/4"),
|
|
||||||
},
|
|
||||||
3330: {
|
|
||||||
// [RFC3330] Special-Use IPv4 Addresses
|
|
||||||
|
|
||||||
// Addresses in this block refer to source hosts on
|
|
||||||
// "this" network. Address 0.0.0.0/32 may be used as a
|
|
||||||
// source address for this host on this network; other
|
|
||||||
// addresses within 0.0.0.0/8 may be used to refer to
|
|
||||||
// specified hosts on this network [RFC1700, page 4].
|
|
||||||
MustIPv4Addr("0.0.0.0/8"),
|
|
||||||
|
|
||||||
// 10.0.0.0/8 - This block is set aside for use in
|
|
||||||
// private networks. Its intended use is documented in
|
|
||||||
// [RFC1918]. Addresses within this block should not
|
|
||||||
// appear on the public Internet.
|
|
||||||
MustIPv4Addr("10.0.0.0/8"),
|
|
||||||
|
|
||||||
// 14.0.0.0/8 - This block is set aside for assignments
|
|
||||||
// to the international system of Public Data Networks
|
|
||||||
// [RFC1700, page 181]. The registry of assignments
|
|
||||||
// within this block can be accessed from the "Public
|
|
||||||
// Data Network Numbers" link on the web page at
|
|
||||||
// http://www.iana.org/numbers.html. Addresses within
|
|
||||||
// this block are assigned to users and should be
|
|
||||||
// treated as such.
|
|
||||||
|
|
||||||
// 24.0.0.0/8 - This block was allocated in early 1996
|
|
||||||
// for use in provisioning IP service over cable
|
|
||||||
// television systems. Although the IANA initially was
|
|
||||||
// involved in making assignments to cable operators,
|
|
||||||
// this responsibility was transferred to American
|
|
||||||
// Registry for Internet Numbers (ARIN) in May 2001.
|
|
||||||
// Addresses within this block are assigned in the
|
|
||||||
// normal manner and should be treated as such.
|
|
||||||
|
|
||||||
// 39.0.0.0/8 - This block was used in the "Class A
|
|
||||||
// Subnet Experiment" that commenced in May 1995, as
|
|
||||||
// documented in [RFC1797]. The experiment has been
|
|
||||||
// completed and this block has been returned to the
|
|
||||||
// pool of addresses reserved for future allocation or
|
|
||||||
// assignment. This block therefore no longer has a
|
|
||||||
// special use and is subject to allocation to a
|
|
||||||
// Regional Internet Registry for assignment in the
|
|
||||||
// normal manner.
|
|
||||||
|
|
||||||
// 127.0.0.0/8 - This block is assigned for use as the Internet host
|
|
||||||
// loopback address. A datagram sent by a higher level protocol to an
|
|
||||||
// address anywhere within this block should loop back inside the host.
|
|
||||||
// This is ordinarily implemented using only 127.0.0.1/32 for loopback,
|
|
||||||
// but no addresses within this block should ever appear on any network
|
|
||||||
// anywhere [RFC1700, page 5].
|
|
||||||
MustIPv4Addr("127.0.0.0/8"),
|
|
||||||
|
|
||||||
// 128.0.0.0/16 - This block, corresponding to the
|
|
||||||
// numerically lowest of the former Class B addresses,
|
|
||||||
// was initially and is still reserved by the IANA.
|
|
||||||
// Given the present classless nature of the IP address
|
|
||||||
// space, the basis for the reservation no longer
|
|
||||||
// applies and addresses in this block are subject to
|
|
||||||
// future allocation to a Regional Internet Registry for
|
|
||||||
// assignment in the normal manner.
|
|
||||||
|
|
||||||
// 169.254.0.0/16 - This is the "link local" block. It
|
|
||||||
// is allocated for communication between hosts on a
|
|
||||||
// single link. Hosts obtain these addresses by
|
|
||||||
// auto-configuration, such as when a DHCP server may
|
|
||||||
// not be found.
|
|
||||||
MustIPv4Addr("169.254.0.0/16"),
|
|
||||||
|
|
||||||
// 172.16.0.0/12 - This block is set aside for use in
|
|
||||||
// private networks. Its intended use is documented in
|
|
||||||
// [RFC1918]. Addresses within this block should not
|
|
||||||
// appear on the public Internet.
|
|
||||||
MustIPv4Addr("172.16.0.0/12"),
|
|
||||||
|
|
||||||
// 191.255.0.0/16 - This block, corresponding to the numerically highest
|
|
||||||
// to the former Class B addresses, was initially and is still reserved
|
|
||||||
// by the IANA. Given the present classless nature of the IP address
|
|
||||||
// space, the basis for the reservation no longer applies and addresses
|
|
||||||
// in this block are subject to future allocation to a Regional Internet
|
|
||||||
// Registry for assignment in the normal manner.
|
|
||||||
|
|
||||||
// 192.0.0.0/24 - This block, corresponding to the
|
|
||||||
// numerically lowest of the former Class C addresses,
|
|
||||||
// was initially and is still reserved by the IANA.
|
|
||||||
// Given the present classless nature of the IP address
|
|
||||||
// space, the basis for the reservation no longer
|
|
||||||
// applies and addresses in this block are subject to
|
|
||||||
// future allocation to a Regional Internet Registry for
|
|
||||||
// assignment in the normal manner.
|
|
||||||
|
|
||||||
// 192.0.2.0/24 - This block is assigned as "TEST-NET" for use in
|
|
||||||
// documentation and example code. It is often used in conjunction with
|
|
||||||
// domain names example.com or example.net in vendor and protocol
|
|
||||||
// documentation. Addresses within this block should not appear on the
|
|
||||||
// public Internet.
|
|
||||||
MustIPv4Addr("192.0.2.0/24"),
|
|
||||||
|
|
||||||
// 192.88.99.0/24 - This block is allocated for use as 6to4 relay
|
|
||||||
// anycast addresses, according to [RFC3068].
|
|
||||||
MustIPv4Addr("192.88.99.0/24"),
|
|
||||||
|
|
||||||
// 192.168.0.0/16 - This block is set aside for use in private networks.
|
|
||||||
// Its intended use is documented in [RFC1918]. Addresses within this
|
|
||||||
// block should not appear on the public Internet.
|
|
||||||
MustIPv4Addr("192.168.0.0/16"),
|
|
||||||
|
|
||||||
// 198.18.0.0/15 - This block has been allocated for use
|
|
||||||
// in benchmark tests of network interconnect devices.
|
|
||||||
// Its use is documented in [RFC2544].
|
|
||||||
MustIPv4Addr("198.18.0.0/15"),
|
|
||||||
|
|
||||||
// 223.255.255.0/24 - This block, corresponding to the
|
|
||||||
// numerically highest of the former Class C addresses,
|
|
||||||
// was initially and is still reserved by the IANA.
|
|
||||||
// Given the present classless nature of the IP address
|
|
||||||
// space, the basis for the reservation no longer
|
|
||||||
// applies and addresses in this block are subject to
|
|
||||||
// future allocation to a Regional Internet Registry for
|
|
||||||
// assignment in the normal manner.
|
|
||||||
|
|
||||||
// 224.0.0.0/4 - This block, formerly known as the Class
|
|
||||||
// D address space, is allocated for use in IPv4
|
|
||||||
// multicast address assignments. The IANA guidelines
|
|
||||||
// for assignments from this space are described in
|
|
||||||
// [RFC3171].
|
|
||||||
MustIPv4Addr("224.0.0.0/4"),
|
|
||||||
|
|
||||||
// 240.0.0.0/4 - This block, formerly known as the Class E address
|
|
||||||
// space, is reserved. The "limited broadcast" destination address
|
|
||||||
// 255.255.255.255 should never be forwarded outside the (sub-)net of
|
|
||||||
// the source. The remainder of this space is reserved
|
|
||||||
// for future use. [RFC1700, page 4]
|
|
||||||
MustIPv4Addr("240.0.0.0/4"),
|
|
||||||
},
|
|
||||||
3849: {
|
|
||||||
// [RFC3849] IPv6 Address Prefix Reserved for Documentation
|
|
||||||
MustIPv6Addr("2001:db8::/32"), // [RFC3849], §4 IANA Considerations
|
|
||||||
},
|
|
||||||
3927: {
|
|
||||||
// [RFC3927] Dynamic Configuration of IPv4 Link-Local Addresses
|
|
||||||
MustIPv4Addr("169.254.0.0/16"), // [RFC3927], §2.1 Link-Local Address Selection
|
|
||||||
},
|
|
||||||
4038: {
|
|
||||||
// [RFC4038] Application Aspects of IPv6 Transition
|
|
||||||
|
|
||||||
// [RFC4038], §4.2. IPv6 Applications in a Dual-Stack Node
|
|
||||||
MustIPv6Addr("0:0:0:0:0:ffff::/96"),
|
|
||||||
},
|
|
||||||
4193: {
|
|
||||||
// [RFC4193] Unique Local IPv6 Unicast Addresses
|
|
||||||
MustIPv6Addr("fc00::/7"),
|
|
||||||
},
|
|
||||||
4291: {
|
|
||||||
// [RFC4291] IP Version 6 Addressing Architecture
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.2 The Unspecified Address
|
|
||||||
MustIPv6Addr("::/128"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.3 The Loopback Address
|
|
||||||
MustIPv6Addr("::1/128"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.5.1. IPv4-Compatible IPv6 Address
|
|
||||||
MustIPv6Addr("::/96"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.5.2. IPv4-Mapped IPv6 Address
|
|
||||||
MustIPv6Addr("::ffff:0:0/96"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.6 Link-Local IPv6 Unicast Addresses
|
|
||||||
MustIPv6Addr("fe80::/10"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.5.7 Site-Local IPv6 Unicast Addresses
|
|
||||||
// (depreciated)
|
|
||||||
MustIPv6Addr("fec0::/10"),
|
|
||||||
|
|
||||||
// [RFC4291], §2.7 Multicast Addresses
|
|
||||||
MustIPv6Addr("ff00::/8"),
|
|
||||||
|
|
||||||
// IPv6 Multicast Information.
|
|
||||||
//
|
|
||||||
// In the following "table" below, `ff0x` is replaced
|
|
||||||
// with the following values depending on the scope of
|
|
||||||
// the query:
|
|
||||||
//
|
|
||||||
// IPv6 Multicast Scopes:
|
|
||||||
// * ff00/9 // reserved
|
|
||||||
// * ff01/9 // interface-local
|
|
||||||
// * ff02/9 // link-local
|
|
||||||
// * ff03/9 // realm-local
|
|
||||||
// * ff04/9 // admin-local
|
|
||||||
// * ff05/9 // site-local
|
|
||||||
// * ff08/9 // organization-local
|
|
||||||
// * ff0e/9 // global
|
|
||||||
// * ff0f/9 // reserved
|
|
||||||
//
|
|
||||||
// IPv6 Multicast Addresses:
|
|
||||||
// * ff0x::2 // All routers
|
|
||||||
// * ff02::5 // OSPFIGP
|
|
||||||
// * ff02::6 // OSPFIGP Designated Routers
|
|
||||||
// * ff02::9 // RIP Routers
|
|
||||||
// * ff02::a // EIGRP Routers
|
|
||||||
// * ff02::d // All PIM Routers
|
|
||||||
// * ff02::1a // All RPL Routers
|
|
||||||
// * ff0x::fb // mDNSv6
|
|
||||||
// * ff0x::101 // All Network Time Protocol (NTP) servers
|
|
||||||
// * ff02::1:1 // Link Name
|
|
||||||
// * ff02::1:2 // All-dhcp-agents
|
|
||||||
// * ff02::1:3 // Link-local Multicast Name Resolution
|
|
||||||
// * ff05::1:3 // All-dhcp-servers
|
|
||||||
// * ff02::1:ff00:0/104 // Solicited-node multicast address.
|
|
||||||
// * ff02::2:ff00:0/104 // Node Information Queries
|
|
||||||
},
|
|
||||||
4380: {
|
|
||||||
// [RFC4380] Teredo: Tunneling IPv6 over UDP through
|
|
||||||
// Network Address Translations (NATs)
|
|
||||||
|
|
||||||
// [RFC4380], §2.6 Global Teredo IPv6 Service Prefix
|
|
||||||
MustIPv6Addr("2001:0000::/32"),
|
|
||||||
},
|
|
||||||
4773: {
|
|
||||||
// [RFC4773] Administration of the IANA Special Purpose IPv6 Address Block
|
|
||||||
MustIPv6Addr("2001:0000::/23"), // IANA
|
|
||||||
},
|
|
||||||
4843: {
|
|
||||||
// [RFC4843] An IPv6 Prefix for Overlay Routable Cryptographic Hash Identifiers (ORCHID)
|
|
||||||
MustIPv6Addr("2001:10::/28"), // [RFC4843], §7 IANA Considerations
|
|
||||||
},
|
|
||||||
5180: {
|
|
||||||
// [RFC5180] IPv6 Benchmarking Methodology for Network Interconnect Devices
|
|
||||||
MustIPv6Addr("2001:0200::/48"), // [RFC5180], §8 IANA Considerations
|
|
||||||
},
|
|
||||||
5735: {
|
|
||||||
// [RFC5735] Special Use IPv4 Addresses
|
|
||||||
MustIPv4Addr("192.0.2.0/24"), // TEST-NET-1
|
|
||||||
MustIPv4Addr("198.51.100.0/24"), // TEST-NET-2
|
|
||||||
MustIPv4Addr("203.0.113.0/24"), // TEST-NET-3
|
|
||||||
MustIPv4Addr("198.18.0.0/15"), // Benchmarks
|
|
||||||
},
|
|
||||||
5737: {
|
|
||||||
// [RFC5737] IPv4 Address Blocks Reserved for Documentation
|
|
||||||
MustIPv4Addr("192.0.2.0/24"), // TEST-NET-1
|
|
||||||
MustIPv4Addr("198.51.100.0/24"), // TEST-NET-2
|
|
||||||
MustIPv4Addr("203.0.113.0/24"), // TEST-NET-3
|
|
||||||
},
|
|
||||||
6052: {
|
|
||||||
// [RFC6052] IPv6 Addressing of IPv4/IPv6 Translators
|
|
||||||
MustIPv6Addr("64:ff9b::/96"), // [RFC6052], §2.1. Well-Known Prefix
|
|
||||||
},
|
|
||||||
6333: {
|
|
||||||
// [RFC6333] Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion
|
|
||||||
MustIPv4Addr("192.0.0.0/29"), // [RFC6333], §5.7 Well-Known IPv4 Address
|
|
||||||
},
|
|
||||||
6598: {
|
|
||||||
// [RFC6598] IANA-Reserved IPv4 Prefix for Shared Address Space
|
|
||||||
MustIPv4Addr("100.64.0.0/10"),
|
|
||||||
},
|
|
||||||
6666: {
|
|
||||||
// [RFC6666] A Discard Prefix for IPv6
|
|
||||||
MustIPv6Addr("0100::/64"),
|
|
||||||
},
|
|
||||||
6890: {
|
|
||||||
// [RFC6890] Special-Purpose IP Address Registries
|
|
||||||
|
|
||||||
// From "RFC6890 §2.2.1 Information Requirements":
|
|
||||||
/*
|
|
||||||
The IPv4 and IPv6 Special-Purpose Address Registries maintain the
|
|
||||||
following information regarding each entry:
|
|
||||||
|
|
||||||
o Address Block - A block of IPv4 or IPv6 addresses that has been
|
|
||||||
registered for a special purpose.
|
|
||||||
|
|
||||||
o Name - A descriptive name for the special-purpose address block.
|
|
||||||
|
|
||||||
o RFC - The RFC through which the special-purpose address block was
|
|
||||||
requested.
|
|
||||||
|
|
||||||
o Allocation Date - The date upon which the special-purpose address
|
|
||||||
block was allocated.
|
|
||||||
|
|
||||||
o Termination Date - The date upon which the allocation is to be
|
|
||||||
terminated. This field is applicable for limited-use allocations
|
|
||||||
only.
|
|
||||||
|
|
||||||
o Source - A boolean value indicating whether an address from the
|
|
||||||
allocated special-purpose address block is valid when used as the
|
|
||||||
source address of an IP datagram that transits two devices.
|
|
||||||
|
|
||||||
o Destination - A boolean value indicating whether an address from
|
|
||||||
the allocated special-purpose address block is valid when used as
|
|
||||||
the destination address of an IP datagram that transits two
|
|
||||||
devices.
|
|
||||||
|
|
||||||
o Forwardable - A boolean value indicating whether a router may
|
|
||||||
forward an IP datagram whose destination address is drawn from the
|
|
||||||
allocated special-purpose address block between external
|
|
||||||
interfaces.
|
|
||||||
|
|
||||||
o Global - A boolean value indicating whether an IP datagram whose
|
|
||||||
destination address is drawn from the allocated special-purpose
|
|
||||||
address block is forwardable beyond a specified administrative
|
|
||||||
domain.
|
|
||||||
|
|
||||||
o Reserved-by-Protocol - A boolean value indicating whether the
|
|
||||||
special-purpose address block is reserved by IP, itself. This
|
|
||||||
value is "TRUE" if the RFC that created the special-purpose
|
|
||||||
address block requires all compliant IP implementations to behave
|
|
||||||
in a special way when processing packets either to or from
|
|
||||||
addresses contained by the address block.
|
|
||||||
|
|
||||||
If the value of "Destination" is FALSE, the values of "Forwardable"
|
|
||||||
and "Global" must also be false.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
* | Attribute | Value |
|
|
||||||
* +----------------------+----------------------------+
|
|
||||||
* | Address Block | 0.0.0.0/8 |
|
|
||||||
* | Name | "This host on this network"|
|
|
||||||
* | RFC | [RFC1122], Section 3.2.1.3 |
|
|
||||||
* | Allocation Date | September 1981 |
|
|
||||||
* | Termination Date | N/A |
|
|
||||||
* | Source | True |
|
|
||||||
* | Destination | False |
|
|
||||||
* | Forwardable | False |
|
|
||||||
* | Global | False |
|
|
||||||
* | Reserved-by-Protocol | True |
|
|
||||||
* +----------------------+----------------------------+*/
|
|
||||||
MustIPv4Addr("0.0.0.0/8"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------+
|
|
||||||
* | Attribute | Value |
|
|
||||||
* +----------------------+---------------+
|
|
||||||
* | Address Block | 10.0.0.0/8 |
|
|
||||||
* | Name | Private-Use |
|
|
||||||
* | RFC | [RFC1918] |
|
|
||||||
* | Allocation Date | February 1996 |
|
|
||||||
* | Termination Date | N/A |
|
|
||||||
* | Source | True |
|
|
||||||
* | Destination | True |
|
|
||||||
* | Forwardable | True |
|
|
||||||
* | Global | False |
|
|
||||||
* | Reserved-by-Protocol | False |
|
|
||||||
* +----------------------+---------------+ */
|
|
||||||
MustIPv4Addr("10.0.0.0/8"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------+
|
|
||||||
| Address Block | 100.64.0.0/10 |
|
|
||||||
| Name | Shared Address Space |
|
|
||||||
| RFC | [RFC6598] |
|
|
||||||
| Allocation Date | April 2012 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------+*/
|
|
||||||
MustIPv4Addr("100.64.0.0/10"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------------+
|
|
||||||
| Address Block | 127.0.0.0/8 |
|
|
||||||
| Name | Loopback |
|
|
||||||
| RFC | [RFC1122], Section 3.2.1.3 |
|
|
||||||
| Allocation Date | September 1981 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False [1] |
|
|
||||||
| Destination | False [1] |
|
|
||||||
| Forwardable | False [1] |
|
|
||||||
| Global | False [1] |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+----------------------------+*/
|
|
||||||
// [1] Several protocols have been granted exceptions to
|
|
||||||
// this rule. For examples, see [RFC4379] and
|
|
||||||
// [RFC5884].
|
|
||||||
MustIPv4Addr("127.0.0.0/8"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------+
|
|
||||||
| Address Block | 169.254.0.0/16 |
|
|
||||||
| Name | Link Local |
|
|
||||||
| RFC | [RFC3927] |
|
|
||||||
| Allocation Date | May 2005 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+----------------+*/
|
|
||||||
MustIPv4Addr("169.254.0.0/16"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------+
|
|
||||||
| Address Block | 172.16.0.0/12 |
|
|
||||||
| Name | Private-Use |
|
|
||||||
| RFC | [RFC1918] |
|
|
||||||
| Allocation Date | February 1996 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------+*/
|
|
||||||
MustIPv4Addr("172.16.0.0/12"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------------------------+
|
|
||||||
| Address Block | 192.0.0.0/24 [2] |
|
|
||||||
| Name | IETF Protocol Assignments |
|
|
||||||
| RFC | Section 2.1 of this document |
|
|
||||||
| Allocation Date | January 2010 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------------------------+*/
|
|
||||||
// [2] Not usable unless by virtue of a more specific
|
|
||||||
// reservation.
|
|
||||||
MustIPv4Addr("192.0.0.0/24"),
|
|
||||||
|
|
||||||
/*+----------------------+--------------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+--------------------------------+
|
|
||||||
| Address Block | 192.0.0.0/29 |
|
|
||||||
| Name | IPv4 Service Continuity Prefix |
|
|
||||||
| RFC | [RFC6333], [RFC7335] |
|
|
||||||
| Allocation Date | June 2011 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+--------------------------------+*/
|
|
||||||
MustIPv4Addr("192.0.0.0/29"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------------+
|
|
||||||
| Address Block | 192.0.2.0/24 |
|
|
||||||
| Name | Documentation (TEST-NET-1) |
|
|
||||||
| RFC | [RFC5737] |
|
|
||||||
| Allocation Date | January 2010 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------------+*/
|
|
||||||
MustIPv4Addr("192.0.2.0/24"),
|
|
||||||
|
|
||||||
/*+----------------------+--------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+--------------------+
|
|
||||||
| Address Block | 192.88.99.0/24 |
|
|
||||||
| Name | 6to4 Relay Anycast |
|
|
||||||
| RFC | [RFC3068] |
|
|
||||||
| Allocation Date | June 2001 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | True |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+--------------------+*/
|
|
||||||
MustIPv4Addr("192.88.99.0/24"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------+
|
|
||||||
| Address Block | 192.168.0.0/16 |
|
|
||||||
| Name | Private-Use |
|
|
||||||
| RFC | [RFC1918] |
|
|
||||||
| Allocation Date | February 1996 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------+*/
|
|
||||||
MustIPv4Addr("192.168.0.0/16"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------+
|
|
||||||
| Address Block | 198.18.0.0/15 |
|
|
||||||
| Name | Benchmarking |
|
|
||||||
| RFC | [RFC2544] |
|
|
||||||
| Allocation Date | March 1999 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------+*/
|
|
||||||
MustIPv4Addr("198.18.0.0/15"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------------+
|
|
||||||
| Address Block | 198.51.100.0/24 |
|
|
||||||
| Name | Documentation (TEST-NET-2) |
|
|
||||||
| RFC | [RFC5737] |
|
|
||||||
| Allocation Date | January 2010 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------------+*/
|
|
||||||
MustIPv4Addr("198.51.100.0/24"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------------+
|
|
||||||
| Address Block | 203.0.113.0/24 |
|
|
||||||
| Name | Documentation (TEST-NET-3) |
|
|
||||||
| RFC | [RFC5737] |
|
|
||||||
| Allocation Date | January 2010 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------------+*/
|
|
||||||
MustIPv4Addr("203.0.113.0/24"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------+
|
|
||||||
| Address Block | 240.0.0.0/4 |
|
|
||||||
| Name | Reserved |
|
|
||||||
| RFC | [RFC1112], Section 4 |
|
|
||||||
| Allocation Date | August 1989 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+----------------------+*/
|
|
||||||
MustIPv4Addr("240.0.0.0/4"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------+
|
|
||||||
| Address Block | 255.255.255.255/32 |
|
|
||||||
| Name | Limited Broadcast |
|
|
||||||
| RFC | [RFC0919], Section 7 |
|
|
||||||
| Allocation Date | October 1984 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------+*/
|
|
||||||
MustIPv4Addr("255.255.255.255/32"),
|
|
||||||
|
|
||||||
/*+----------------------+------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+------------------+
|
|
||||||
| Address Block | ::1/128 |
|
|
||||||
| Name | Loopback Address |
|
|
||||||
| RFC | [RFC4291] |
|
|
||||||
| Allocation Date | February 2006 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+------------------+*/
|
|
||||||
MustIPv6Addr("::1/128"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------------+
|
|
||||||
| Address Block | ::/128 |
|
|
||||||
| Name | Unspecified Address |
|
|
||||||
| RFC | [RFC4291] |
|
|
||||||
| Allocation Date | February 2006 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+---------------------+*/
|
|
||||||
MustIPv6Addr("::/128"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------------+
|
|
||||||
| Address Block | 64:ff9b::/96 |
|
|
||||||
| Name | IPv4-IPv6 Translat. |
|
|
||||||
| RFC | [RFC6052] |
|
|
||||||
| Allocation Date | October 2010 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | True |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------------+*/
|
|
||||||
MustIPv6Addr("64:ff9b::/96"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------------+
|
|
||||||
| Address Block | ::ffff:0:0/96 |
|
|
||||||
| Name | IPv4-mapped Address |
|
|
||||||
| RFC | [RFC4291] |
|
|
||||||
| Allocation Date | February 2006 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+---------------------+*/
|
|
||||||
MustIPv6Addr("::ffff:0:0/96"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------------------+
|
|
||||||
| Address Block | 100::/64 |
|
|
||||||
| Name | Discard-Only Address Block |
|
|
||||||
| RFC | [RFC6666] |
|
|
||||||
| Allocation Date | June 2012 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------------------+*/
|
|
||||||
MustIPv6Addr("100::/64"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------------------+
|
|
||||||
| Address Block | 2001::/23 |
|
|
||||||
| Name | IETF Protocol Assignments |
|
|
||||||
| RFC | [RFC2928] |
|
|
||||||
| Allocation Date | September 2000 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False[1] |
|
|
||||||
| Destination | False[1] |
|
|
||||||
| Forwardable | False[1] |
|
|
||||||
| Global | False[1] |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------------------+*/
|
|
||||||
// [1] Unless allowed by a more specific allocation.
|
|
||||||
MustIPv6Addr("2001::/16"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------+
|
|
||||||
| Address Block | 2001::/32 |
|
|
||||||
| Name | TEREDO |
|
|
||||||
| RFC | [RFC4380] |
|
|
||||||
| Allocation Date | January 2006 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------+*/
|
|
||||||
// Covered by previous entry, included for completeness.
|
|
||||||
//
|
|
||||||
// MustIPv6Addr("2001::/16"),
|
|
||||||
|
|
||||||
/*+----------------------+----------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+----------------+
|
|
||||||
| Address Block | 2001:2::/48 |
|
|
||||||
| Name | Benchmarking |
|
|
||||||
| RFC | [RFC5180] |
|
|
||||||
| Allocation Date | April 2008 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+----------------+*/
|
|
||||||
// Covered by previous entry, included for completeness.
|
|
||||||
//
|
|
||||||
// MustIPv6Addr("2001:2::/48"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------+
|
|
||||||
| Address Block | 2001:db8::/32 |
|
|
||||||
| Name | Documentation |
|
|
||||||
| RFC | [RFC3849] |
|
|
||||||
| Allocation Date | July 2004 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------+*/
|
|
||||||
// Covered by previous entry, included for completeness.
|
|
||||||
//
|
|
||||||
// MustIPv6Addr("2001:db8::/32"),
|
|
||||||
|
|
||||||
/*+----------------------+--------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+--------------+
|
|
||||||
| Address Block | 2001:10::/28 |
|
|
||||||
| Name | ORCHID |
|
|
||||||
| RFC | [RFC4843] |
|
|
||||||
| Allocation Date | March 2007 |
|
|
||||||
| Termination Date | March 2014 |
|
|
||||||
| Source | False |
|
|
||||||
| Destination | False |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+--------------+*/
|
|
||||||
// Covered by previous entry, included for completeness.
|
|
||||||
//
|
|
||||||
// MustIPv6Addr("2001:10::/28"),
|
|
||||||
|
|
||||||
/*+----------------------+---------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+---------------+
|
|
||||||
| Address Block | 2002::/16 [2] |
|
|
||||||
| Name | 6to4 |
|
|
||||||
| RFC | [RFC3056] |
|
|
||||||
| Allocation Date | February 2001 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | N/A [2] |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+---------------+*/
|
|
||||||
// [2] See [RFC3056] for details.
|
|
||||||
MustIPv6Addr("2002::/16"),
|
|
||||||
|
|
||||||
/*+----------------------+--------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+--------------+
|
|
||||||
| Address Block | fc00::/7 |
|
|
||||||
| Name | Unique-Local |
|
|
||||||
| RFC | [RFC4193] |
|
|
||||||
| Allocation Date | October 2005 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | True |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | False |
|
|
||||||
+----------------------+--------------+*/
|
|
||||||
MustIPv6Addr("fc00::/7"),
|
|
||||||
|
|
||||||
/*+----------------------+-----------------------+
|
|
||||||
| Attribute | Value |
|
|
||||||
+----------------------+-----------------------+
|
|
||||||
| Address Block | fe80::/10 |
|
|
||||||
| Name | Linked-Scoped Unicast |
|
|
||||||
| RFC | [RFC4291] |
|
|
||||||
| Allocation Date | February 2006 |
|
|
||||||
| Termination Date | N/A |
|
|
||||||
| Source | True |
|
|
||||||
| Destination | True |
|
|
||||||
| Forwardable | False |
|
|
||||||
| Global | False |
|
|
||||||
| Reserved-by-Protocol | True |
|
|
||||||
+----------------------+-----------------------+*/
|
|
||||||
MustIPv6Addr("fe80::/10"),
|
|
||||||
},
|
|
||||||
7335: {
|
|
||||||
// [RFC7335] IPv4 Service Continuity Prefix
|
|
||||||
MustIPv4Addr("192.0.0.0/29"), // [RFC7335], §6 IANA Considerations
|
|
||||||
},
|
|
||||||
ForwardingBlacklist: { // Pseudo-RFC
|
|
||||||
// Blacklist of non-forwardable IP blocks taken from RFC6890
|
|
||||||
//
|
|
||||||
// TODO: the attributes for forwardable should be
|
|
||||||
// searcahble and embedded in the main list of RFCs
|
|
||||||
// above.
|
|
||||||
MustIPv4Addr("0.0.0.0/8"),
|
|
||||||
MustIPv4Addr("127.0.0.0/8"),
|
|
||||||
MustIPv4Addr("169.254.0.0/16"),
|
|
||||||
MustIPv4Addr("192.0.0.0/24"),
|
|
||||||
MustIPv4Addr("192.0.2.0/24"),
|
|
||||||
MustIPv4Addr("198.51.100.0/24"),
|
|
||||||
MustIPv4Addr("203.0.113.0/24"),
|
|
||||||
MustIPv4Addr("240.0.0.0/4"),
|
|
||||||
MustIPv4Addr("255.255.255.255/32"),
|
|
||||||
MustIPv6Addr("::1/128"),
|
|
||||||
MustIPv6Addr("::/128"),
|
|
||||||
MustIPv6Addr("::ffff:0:0/96"),
|
|
||||||
|
|
||||||
// There is no way of expressing a whitelist per RFC2928
|
|
||||||
// atm without creating a negative mask, which I don't
|
|
||||||
// want to do atm.
|
|
||||||
//MustIPv6Addr("2001::/23"),
|
|
||||||
|
|
||||||
MustIPv6Addr("2001:db8::/32"),
|
|
||||||
MustIPv6Addr("2001:10::/28"),
|
|
||||||
MustIPv6Addr("fe80::/10"),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// VisitAllRFCs iterates over all known RFCs and calls the visitor
|
|
||||||
func VisitAllRFCs(fn func(rfcNum uint, sockaddrs SockAddrs)) {
|
|
||||||
rfcNetMap := KnownRFCs()
|
|
||||||
|
|
||||||
// Blacklist of faux-RFCs. Don't show the world that we're abusing the
|
|
||||||
// RFC system in this library.
|
|
||||||
rfcBlacklist := map[uint]struct{}{
|
|
||||||
ForwardingBlacklist: {},
|
|
||||||
}
|
|
||||||
|
|
||||||
for rfcNum, sas := range rfcNetMap {
|
|
||||||
if _, found := rfcBlacklist[rfcNum]; !found {
|
|
||||||
fn(rfcNum, sas)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
19
vendor/github.com/hashicorp/go-sockaddr/route_info.go
generated
vendored
19
vendor/github.com/hashicorp/go-sockaddr/route_info.go
generated
vendored
|
@ -1,19 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
// RouteInterface specifies an interface for obtaining memoized route table and
|
|
||||||
// network information from a given OS.
|
|
||||||
type RouteInterface interface {
|
|
||||||
// GetDefaultInterfaceName returns the name of the interface that has a
|
|
||||||
// default route or an error and an empty string if a problem was
|
|
||||||
// encountered.
|
|
||||||
GetDefaultInterfaceName() (string, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// VisitCommands visits each command used by the platform-specific RouteInfo
|
|
||||||
// implementation.
|
|
||||||
func (ri routeInfo) VisitCommands(fn func(name string, cmd []string)) {
|
|
||||||
for k, v := range ri.cmds {
|
|
||||||
cmds := append([]string(nil), v...)
|
|
||||||
fn(k, cmds)
|
|
||||||
}
|
|
||||||
}
|
|
36
vendor/github.com/hashicorp/go-sockaddr/route_info_bsd.go
generated
vendored
36
vendor/github.com/hashicorp/go-sockaddr/route_info_bsd.go
generated
vendored
|
@ -1,36 +0,0 @@
|
||||||
// +build darwin dragonfly freebsd netbsd openbsd
|
|
||||||
|
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import "os/exec"
|
|
||||||
|
|
||||||
var cmds map[string][]string = map[string][]string{
|
|
||||||
"route": {"/sbin/route", "-n", "get", "default"},
|
|
||||||
}
|
|
||||||
|
|
||||||
type routeInfo struct {
|
|
||||||
cmds map[string][]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewRouteInfo returns a BSD-specific implementation of the RouteInfo
|
|
||||||
// interface.
|
|
||||||
func NewRouteInfo() (routeInfo, error) {
|
|
||||||
return routeInfo{
|
|
||||||
cmds: cmds,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDefaultInterfaceName returns the interface name attached to the default
|
|
||||||
// route on the default interface.
|
|
||||||
func (ri routeInfo) GetDefaultInterfaceName() (string, error) {
|
|
||||||
out, err := exec.Command(cmds["route"][0], cmds["route"][1:]...).Output()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
var ifName string
|
|
||||||
if ifName, err = parseDefaultIfNameFromRoute(string(out)); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return ifName, nil
|
|
||||||
}
|
|
10
vendor/github.com/hashicorp/go-sockaddr/route_info_default.go
generated
vendored
10
vendor/github.com/hashicorp/go-sockaddr/route_info_default.go
generated
vendored
|
@ -1,10 +0,0 @@
|
||||||
// +build android nacl plan9
|
|
||||||
|
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import "errors"
|
|
||||||
|
|
||||||
// getDefaultIfName is the default interface function for unsupported platforms.
|
|
||||||
func getDefaultIfName() (string, error) {
|
|
||||||
return "", errors.New("No default interface found (unsupported platform)")
|
|
||||||
}
|
|
40
vendor/github.com/hashicorp/go-sockaddr/route_info_linux.go
generated
vendored
40
vendor/github.com/hashicorp/go-sockaddr/route_info_linux.go
generated
vendored
|
@ -1,40 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"os/exec"
|
|
||||||
)
|
|
||||||
|
|
||||||
type routeInfo struct {
|
|
||||||
cmds map[string][]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewRouteInfo returns a Linux-specific implementation of the RouteInfo
|
|
||||||
// interface.
|
|
||||||
func NewRouteInfo() (routeInfo, error) {
|
|
||||||
// CoreOS Container Linux moved ip to /usr/bin/ip, so look it up on
|
|
||||||
// $PATH and fallback to /sbin/ip on error.
|
|
||||||
path, _ := exec.LookPath("ip")
|
|
||||||
if path == "" {
|
|
||||||
path = "/sbin/ip"
|
|
||||||
}
|
|
||||||
|
|
||||||
return routeInfo{
|
|
||||||
cmds: map[string][]string{"ip": {path, "route"}},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDefaultInterfaceName returns the interface name attached to the default
|
|
||||||
// route on the default interface.
|
|
||||||
func (ri routeInfo) GetDefaultInterfaceName() (string, error) {
|
|
||||||
out, err := exec.Command(ri.cmds["ip"][0], ri.cmds["ip"][1:]...).Output()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
var ifName string
|
|
||||||
if ifName, err = parseDefaultIfNameFromIPCmd(string(out)); err != nil {
|
|
||||||
return "", errors.New("No default interface found")
|
|
||||||
}
|
|
||||||
return ifName, nil
|
|
||||||
}
|
|
37
vendor/github.com/hashicorp/go-sockaddr/route_info_solaris.go
generated
vendored
37
vendor/github.com/hashicorp/go-sockaddr/route_info_solaris.go
generated
vendored
|
@ -1,37 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"os/exec"
|
|
||||||
)
|
|
||||||
|
|
||||||
var cmds map[string][]string = map[string][]string{
|
|
||||||
"route": {"/usr/sbin/route", "-n", "get", "default"},
|
|
||||||
}
|
|
||||||
|
|
||||||
type routeInfo struct {
|
|
||||||
cmds map[string][]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewRouteInfo returns a BSD-specific implementation of the RouteInfo
|
|
||||||
// interface.
|
|
||||||
func NewRouteInfo() (routeInfo, error) {
|
|
||||||
return routeInfo{
|
|
||||||
cmds: cmds,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDefaultInterfaceName returns the interface name attached to the default
|
|
||||||
// route on the default interface.
|
|
||||||
func (ri routeInfo) GetDefaultInterfaceName() (string, error) {
|
|
||||||
out, err := exec.Command(cmds["route"][0], cmds["route"][1:]...).Output()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
var ifName string
|
|
||||||
if ifName, err = parseDefaultIfNameFromRoute(string(out)); err != nil {
|
|
||||||
return "", errors.New("No default interface found")
|
|
||||||
}
|
|
||||||
return ifName, nil
|
|
||||||
}
|
|
41
vendor/github.com/hashicorp/go-sockaddr/route_info_windows.go
generated
vendored
41
vendor/github.com/hashicorp/go-sockaddr/route_info_windows.go
generated
vendored
|
@ -1,41 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import "os/exec"
|
|
||||||
|
|
||||||
var cmds map[string][]string = map[string][]string{
|
|
||||||
"netstat": {"netstat", "-rn"},
|
|
||||||
"ipconfig": {"ipconfig"},
|
|
||||||
}
|
|
||||||
|
|
||||||
type routeInfo struct {
|
|
||||||
cmds map[string][]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewRouteInfo returns a BSD-specific implementation of the RouteInfo
|
|
||||||
// interface.
|
|
||||||
func NewRouteInfo() (routeInfo, error) {
|
|
||||||
return routeInfo{
|
|
||||||
cmds: cmds,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDefaultInterfaceName returns the interface name attached to the default
|
|
||||||
// route on the default interface.
|
|
||||||
func (ri routeInfo) GetDefaultInterfaceName() (string, error) {
|
|
||||||
ifNameOut, err := exec.Command(cmds["netstat"][0], cmds["netstat"][1:]...).Output()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ipconfigOut, err := exec.Command(cmds["ipconfig"][0], cmds["ipconfig"][1:]...).Output()
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
ifName, err := parseDefaultIfNameWindows(string(ifNameOut), string(ipconfigOut))
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
return ifName, nil
|
|
||||||
}
|
|
206
vendor/github.com/hashicorp/go-sockaddr/sockaddr.go
generated
vendored
206
vendor/github.com/hashicorp/go-sockaddr/sockaddr.go
generated
vendored
|
@ -1,206 +0,0 @@
|
||||||
package sockaddr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
type SockAddrType int
|
|
||||||
type AttrName string
|
|
||||||
|
|
||||||
const (
|
|
||||||
TypeUnknown SockAddrType = 0x0
|
|
||||||
TypeUnix = 0x1
|
|
||||||
TypeIPv4 = 0x2
|
|
||||||
TypeIPv6 = 0x4
|
|
||||||
|
|
||||||
// TypeIP is the union of TypeIPv4 and TypeIPv6
|
|
||||||
TypeIP = 0x6
|
|
||||||
)
|
|
||||||
|
|
||||||
type SockAddr interface {
|
|
||||||
// CmpRFC returns 0 if SockAddr exactly matches one of the matched RFC
|
|
||||||
// networks, -1 if the receiver is contained within the RFC network, or
|
|
||||||
// 1 if the address is not contained within the RFC.
|
|
||||||
CmpRFC(rfcNum uint, sa SockAddr) int
|
|
||||||
|
|
||||||
// Contains returns true if the SockAddr arg is contained within the
|
|
||||||
// receiver
|
|
||||||
Contains(SockAddr) bool
|
|
||||||
|
|
||||||
// Equal allows for the comparison of two SockAddrs
|
|
||||||
Equal(SockAddr) bool
|
|
||||||
|
|
||||||
DialPacketArgs() (string, string)
|
|
||||||
DialStreamArgs() (string, string)
|
|
||||||
ListenPacketArgs() (string, string)
|
|
||||||
ListenStreamArgs() (string, string)
|
|
||||||
|
|
||||||
// String returns the string representation of SockAddr
|
|
||||||
String() string
|
|
||||||
|
|
||||||
// Type returns the SockAddrType
|
|
||||||
Type() SockAddrType
|
|
||||||
}
|
|
||||||
|
|
||||||
// sockAddrAttrMap is a map of the SockAddr type-specific attributes.
|
|
||||||
var sockAddrAttrMap map[AttrName]func(SockAddr) string
|
|
||||||
var sockAddrAttrs []AttrName
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
sockAddrInit()
|
|
||||||
}
|
|
||||||
|
|
||||||
// New creates a new SockAddr from the string. The order in which New()
|
|
||||||
// attempts to construct a SockAddr is: IPv4Addr, IPv6Addr, SockAddrUnix.
|
|
||||||
//
|
|
||||||
// NOTE: New() relies on the heuristic wherein if the path begins with either a
|
|
||||||
// '.' or '/' character before creating a new UnixSock. For UNIX sockets that
|
|
||||||
// are absolute paths or are nested within a sub-directory, this works as
|
|
||||||
// expected, however if the UNIX socket is contained in the current working
|
|
||||||
// directory, this will fail unless the path begins with "./"
|
|
||||||
// (e.g. "./my-local-socket"). Calls directly to NewUnixSock() do not suffer
|
|
||||||
// this limitation. Invalid IP addresses such as "256.0.0.0/-1" will run afoul
|
|
||||||
// of this heuristic and be assumed to be a valid UNIX socket path (which they
|
|
||||||
// are, but it is probably not what you want and you won't realize it until you
|
|
||||||
// stat(2) the file system to discover it doesn't exist).
|
|
||||||
func NewSockAddr(s string) (SockAddr, error) {
|
|
||||||
ipv4Addr, err := NewIPv4Addr(s)
|
|
||||||
if err == nil {
|
|
||||||
return ipv4Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ipv6Addr, err := NewIPv6Addr(s)
|
|
||||||
if err == nil {
|
|
||||||
return ipv6Addr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check to make sure the string begins with either a '.' or '/', or
|
|
||||||
// contains a '/'.
|
|
||||||
if len(s) > 1 && (strings.IndexAny(s[0:1], "./") != -1 || strings.IndexByte(s, '/') != -1) {
|
|
||||||
unixSock, err := NewUnixSock(s)
|
|
||||||
if err == nil {
|
|
||||||
return unixSock, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("Unable to convert %q to an IPv4 or IPv6 address, or a UNIX Socket", s)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToIPAddr returns an IPAddr type or nil if the type conversion fails.
|
|
||||||
func ToIPAddr(sa SockAddr) *IPAddr {
|
|
||||||
ipa, ok := sa.(IPAddr)
|
|
||||||
if !ok {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return &ipa
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToIPv4Addr returns an IPv4Addr type or nil if the type conversion fails.
|
|
||||||
func ToIPv4Addr(sa SockAddr) *IPv4Addr {
|
|
||||||
switch v := sa.(type) {
|
|
||||||
case IPv4Addr:
|
|
||||||
return &v
|
|
||||||
default:
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToIPv6Addr returns an IPv6Addr type or nil if the type conversion fails.
|
|
||||||
func ToIPv6Addr(sa SockAddr) *IPv6Addr {
|
|
||||||
switch v := sa.(type) {
|
|
||||||
case IPv6Addr:
|
|
||||||
return &v
|
|
||||||
default:
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToUnixSock returns a UnixSock type or nil if the type conversion fails.
|
|
||||||
func ToUnixSock(sa SockAddr) *UnixSock {
|
|
||||||
switch v := sa.(type) {
|
|
||||||
case UnixSock:
|
|
||||||
return &v
|
|
||||||
default:
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SockAddrAttr returns a string representation of an attribute for the given
|
|
||||||
// SockAddr.
|
|
||||||
func SockAddrAttr(sa SockAddr, selector AttrName) string {
|
|
||||||
fn, found := sockAddrAttrMap[selector]
|
|
||||||
if !found {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return fn(sa)
|
|
||||||
}
|
|
||||||
|
|
||||||
// String() for SockAddrType returns a string representation of the
|
|
||||||
// SockAddrType (e.g. "IPv4", "IPv6", "UNIX", "IP", or "unknown").
|
|
||||||
func (sat SockAddrType) String() string {
|
|
||||||
switch sat {
|
|
||||||
case TypeIPv4:
|
|
||||||
return "IPv4"
|
|
||||||
case TypeIPv6:
|
|
||||||
return "IPv6"
|
|
||||||
// There is no concrete "IP" type. Leaving here as a reminder.
|
|
||||||
// case TypeIP:
|
|
||||||
// return "IP"
|
|
||||||
case TypeUnix:
|
|
||||||
return "UNIX"
|
|
||||||
default:
|
|
||||||
panic("unsupported type")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// sockAddrInit is called once at init()
|
|
||||||
func sockAddrInit() {
|
|
||||||
sockAddrAttrs = []AttrName{
|
|
||||||
"type", // type should be first
|
|
||||||
"string",
|
|
||||||
}
|
|
||||||
|
|
||||||
sockAddrAttrMap = map[AttrName]func(sa SockAddr) string{
|
|
||||||
"string": func(sa SockAddr) string {
|
|
||||||
return sa.String()
|
|
||||||
},
|
|
||||||
"type": func(sa SockAddr) string {
|
|
||||||
return sa.Type().String()
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// UnixSockAttrs returns a list of attributes supported by the UnixSock type
|
|
||||||
func SockAddrAttrs() []AttrName {
|
|
||||||
return sockAddrAttrs
|
|
||||||
}
|
|
||||||
|
|
||||||
// Although this is pretty trivial to do in a program, having the logic here is
|
|
||||||
// useful all around. Note that this marshals into a *string* -- the underlying
|
|
||||||
// string representation of the sockaddr. If you then unmarshal into this type
|
|
||||||
// in Go, all will work as expected, but externally you can take what comes out
|
|
||||||
// and use the string value directly.
|
|
||||||
type SockAddrMarshaler struct {
|
|
||||||
SockAddr
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *SockAddrMarshaler) MarshalJSON() ([]byte, error) {
|
|
||||||
return json.Marshal(s.SockAddr.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *SockAddrMarshaler) UnmarshalJSON(in []byte) error {
|
|
||||||
var str string
|
|
||||||
err := json.Unmarshal(in, &str)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
sa, err := NewSockAddr(str)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
s.SockAddr = sa
|
|
||||||
return nil
|
|
||||||
}
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue