Add support for SSE-S3 server side encryption with vault (#6192)
Add support for sse-s3 encryption with vault as KMS. Also refactoring code to make use of headers and functions defined in crypto package and clean up duplicated code.master
poornas
6 years ago
committed by
kannappanr
parent
3d197c1449
commit
e71ef905f9
@ -0,0 +1,20 @@ |
||||
// Minio Cloud Storage, (C) 2015, 2016, 2017, 2018 Minio, Inc.
|
||||
//
|
||||
// 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.
|
||||
|
||||
package crypto |
||||
|
||||
// KMSConfig has the KMS config for hashicorp vault
|
||||
type KMSConfig struct { |
||||
Vault VaultConfig `json:"vault"` |
||||
} |
||||
@ -0,0 +1,256 @@ |
||||
// Minio Cloud Storage, (C) 2015, 2016, 2017, 2018 Minio, Inc.
|
||||
//
|
||||
// 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.
|
||||
|
||||
package crypto |
||||
|
||||
import ( |
||||
"bytes" |
||||
"encoding/base64" |
||||
"errors" |
||||
"fmt" |
||||
"os" |
||||
"strconv" |
||||
"strings" |
||||
"time" |
||||
|
||||
vault "github.com/hashicorp/vault/api" |
||||
) |
||||
|
||||
const ( |
||||
// VaultEndpointEnv Vault endpoint environment variable
|
||||
VaultEndpointEnv = "MINIO_SSE_VAULT_ENDPOINT" |
||||
// vaultAuthTypeEnv type of vault auth to be used
|
||||
vaultAuthTypeEnv = "MINIO_SSE_VAULT_AUTH_TYPE" |
||||
// vaultAppRoleIDEnv Vault AppRole ID environment variable
|
||||
vaultAppRoleIDEnv = "MINIO_SSE_VAULT_APPROLE_ID" |
||||
// vaultAppSecretIDEnv Vault AppRole Secret environment variable
|
||||
vaultAppSecretIDEnv = "MINIO_SSE_VAULT_APPROLE_SECRET" |
||||
// vaultKeyVersionEnv Vault Key Version environment variable
|
||||
vaultKeyVersionEnv = "MINIO_SSE_VAULT_KEY_VERSION" |
||||
// vaultKeyNameEnv Vault Encryption Key Name environment variable
|
||||
vaultKeyNameEnv = "MINIO_SSE_VAULT_KEY_NAME" |
||||
) |
||||
|
||||
var ( |
||||
//ErrKMSAuthLogin is raised when there is a failure authenticating to KMS
|
||||
ErrKMSAuthLogin = errors.New("Vault service did not return auth info") |
||||
) |
||||
|
||||
type vaultService struct { |
||||
config *VaultConfig |
||||
client *vault.Client |
||||
leaseDuration time.Duration |
||||
} |
||||
|
||||
// return transit secret engine's path for generate data key operation
|
||||
func (v *vaultService) genDataKeyEndpoint(key string) string { |
||||
return "/transit/datakey/plaintext/" + key |
||||
} |
||||
|
||||
// return transit secret engine's path for decrypt operation
|
||||
func (v *vaultService) decryptEndpoint(key string) string { |
||||
return "/transit/decrypt/" + key |
||||
} |
||||
|
||||
// VaultKey represents vault encryption key-id name & version
|
||||
type VaultKey struct { |
||||
Name string `json:"name"` |
||||
Version int `json:"version"` |
||||
} |
||||
|
||||
// VaultAuth represents vault auth type to use. For now, AppRole is the only supported
|
||||
// auth type.
|
||||
type VaultAuth struct { |
||||
Type string `json:"type"` |
||||
AppRole VaultAppRole `json:"approle"` |
||||
} |
||||
|
||||
// VaultAppRole represents vault approle credentials
|
||||
type VaultAppRole struct { |
||||
ID string `json:"id"` |
||||
Secret string `json:"secret"` |
||||
} |
||||
|
||||
// VaultConfig holds config required to start vault service
|
||||
type VaultConfig struct { |
||||
Endpoint string `json:"endpoint"` |
||||
Auth VaultAuth `json:"auth"` |
||||
Key VaultKey `json:"key-id"` |
||||
} |
||||
|
||||
// validate whether all required env variables needed to start vault service have
|
||||
// been set
|
||||
func validateVaultConfig(c *VaultConfig) error { |
||||
if c.Endpoint == "" { |
||||
return fmt.Errorf("Missing hashicorp vault endpoint - %s is empty", VaultEndpointEnv) |
||||
} |
||||
if strings.ToLower(c.Auth.Type) != "approle" { |
||||
return fmt.Errorf("Unsupported hashicorp vault auth type - %s", vaultAuthTypeEnv) |
||||
} |
||||
if c.Auth.AppRole.ID == "" { |
||||
return fmt.Errorf("Missing hashicorp vault AppRole ID - %s is empty", vaultAppRoleIDEnv) |
||||
} |
||||
if c.Auth.AppRole.Secret == "" { |
||||
return fmt.Errorf("Missing hashicorp vault AppSecret ID - %s is empty", vaultAppSecretIDEnv) |
||||
} |
||||
if c.Key.Name == "" { |
||||
return fmt.Errorf("Invalid value set in environment variable %s", vaultKeyNameEnv) |
||||
} |
||||
if c.Key.Version < 0 { |
||||
return fmt.Errorf("Invalid value set in environment variable %s", vaultKeyVersionEnv) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// authenticate to vault with app role id and app role secret, and get a client access token, lease duration
|
||||
func getVaultAccessToken(client *vault.Client, appRoleID, appSecret string) (token string, duration int, err error) { |
||||
data := map[string]interface{}{ |
||||
"role_id": appRoleID, |
||||
"secret_id": appSecret, |
||||
} |
||||
resp, e := client.Logical().Write("auth/approle/login", data) |
||||
if e != nil { |
||||
return token, duration, e |
||||
} |
||||
if resp.Auth == nil { |
||||
return token, duration, ErrKMSAuthLogin |
||||
} |
||||
return resp.Auth.ClientToken, resp.Auth.LeaseDuration, nil |
||||
} |
||||
|
||||
// NewVaultConfig sets KMSConfig from environment
|
||||
// variables and performs validations.
|
||||
func NewVaultConfig() (KMSConfig, error) { |
||||
kc := KMSConfig{} |
||||
endpoint := os.Getenv(VaultEndpointEnv) |
||||
roleID := os.Getenv(vaultAppRoleIDEnv) |
||||
roleSecret := os.Getenv(vaultAppSecretIDEnv) |
||||
keyName := os.Getenv(vaultKeyNameEnv) |
||||
keyVersion := 0 |
||||
authType := "approle" |
||||
if versionStr := os.Getenv(vaultKeyVersionEnv); versionStr != "" { |
||||
version, err := strconv.Atoi(versionStr) |
||||
if err != nil { |
||||
return kc, fmt.Errorf("Unable to parse %s value (`%s`)", vaultKeyVersionEnv, versionStr) |
||||
} |
||||
keyVersion = version |
||||
} |
||||
// return if none of the vault env variables are configured
|
||||
if (endpoint == "") && (roleID == "") && (roleSecret == "") && (keyName == "") && (keyVersion == 0) { |
||||
return kc, nil |
||||
} |
||||
c := VaultConfig{ |
||||
Endpoint: endpoint, |
||||
Auth: VaultAuth{ |
||||
Type: authType, |
||||
AppRole: VaultAppRole{ |
||||
ID: roleID, |
||||
Secret: roleSecret, |
||||
}, |
||||
}, |
||||
Key: VaultKey{ |
||||
Version: keyVersion, |
||||
Name: keyName, |
||||
}, |
||||
} |
||||
if err := validateVaultConfig(&c); err != nil { |
||||
return kc, err |
||||
} |
||||
kc.Vault = c |
||||
return kc, nil |
||||
} |
||||
|
||||
// NewVault initializes Hashicorp Vault KMS by
|
||||
// authenticating to Vault with the credentials in KMSConfig,
|
||||
// and gets a client token for future api calls.
|
||||
func NewVault(kmsConf KMSConfig) (KMS, error) { |
||||
config := kmsConf.Vault |
||||
c, err := vault.NewClient(&vault.Config{ |
||||
Address: config.Endpoint, |
||||
}) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
accessToken, leaseDuration, err := getVaultAccessToken(c, config.Auth.AppRole.ID, config.Auth.AppRole.Secret) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
// authenticate and get the access token
|
||||
c.SetToken(accessToken) |
||||
v := vaultService{client: c, config: &config, leaseDuration: time.Duration(leaseDuration)} |
||||
v.renewToken(c) |
||||
return &v, nil |
||||
} |
||||
|
||||
func (v *vaultService) renewToken(c *vault.Client) { |
||||
retryDelay := 1 * time.Minute |
||||
go func() { |
||||
for { |
||||
s, err := c.Auth().Token().RenewSelf(int(v.leaseDuration)) |
||||
if err != nil { |
||||
time.Sleep(retryDelay) |
||||
continue |
||||
} |
||||
nextRenew := s.Auth.LeaseDuration / 2 |
||||
time.Sleep(time.Duration(nextRenew) * time.Second) |
||||
} |
||||
}() |
||||
} |
||||
|
||||
// Generates a random plain text key, sealed plain text key from
|
||||
// Vault. It returns the plaintext key and sealed plaintext key on success
|
||||
func (v *vaultService) GenerateKey(keyID string, ctx Context) (key [32]byte, sealedKey []byte, err error) { |
||||
contextStream := new(bytes.Buffer) |
||||
ctx.WriteTo(contextStream) |
||||
|
||||
payload := map[string]interface{}{ |
||||
"context": base64.StdEncoding.EncodeToString(contextStream.Bytes()), |
||||
} |
||||
s, err1 := v.client.Logical().Write(v.genDataKeyEndpoint(keyID), payload) |
||||
|
||||
if err1 != nil { |
||||
return key, sealedKey, err1 |
||||
} |
||||
sealKey := s.Data["ciphertext"].(string) |
||||
plainKey, err := base64.StdEncoding.DecodeString(s.Data["plaintext"].(string)) |
||||
if err != nil { |
||||
return key, sealedKey, err1 |
||||
} |
||||
copy(key[:], []byte(plainKey)) |
||||
return key, []byte(sealKey), nil |
||||
} |
||||
|
||||
// unsealKMSKey unseals the sealedKey using the Vault master key
|
||||
// referenced by the keyID. The plain text key is returned on success.
|
||||
func (v *vaultService) UnsealKey(keyID string, sealedKey []byte, ctx Context) (key [32]byte, err error) { |
||||
contextStream := new(bytes.Buffer) |
||||
ctx.WriteTo(contextStream) |
||||
payload := map[string]interface{}{ |
||||
"ciphertext": string(sealedKey), |
||||
"context": base64.StdEncoding.EncodeToString(contextStream.Bytes()), |
||||
} |
||||
s, err1 := v.client.Logical().Write(v.decryptEndpoint(keyID), payload) |
||||
if err1 != nil { |
||||
return key, err1 |
||||
} |
||||
base64Key := s.Data["plaintext"].(string) |
||||
plainKey, err1 := base64.StdEncoding.DecodeString(base64Key) |
||||
if err1 != nil { |
||||
return key, err1 |
||||
} |
||||
copy(key[:], []byte(plainKey)) |
||||
|
||||
return key, nil |
||||
} |
||||
@ -0,0 +1,39 @@ |
||||
# KMS Quickstart Guide [](https://slack.minio.io) |
||||
|
||||
KMS feature allows you to use Vault to generate and manages keys which are used by the minio server to encrypt objects.This document explains how to configure Minio with Vault as KMS. |
||||
|
||||
## Get started |
||||
|
||||
### 1. Prerequisites |
||||
Install Minio - [Minio Quickstart Guide](https://docs.minio.io/docs/minio-quickstart-guide). |
||||
|
||||
### 2. Configure Vault |
||||
Vault as Key Management System requires following to be configured in Vault |
||||
|
||||
- transit backend configured with a named encryption key-ring |
||||
- AppRole based authentication with read/update policy for transit backend. In particular, read and update policy |
||||
are required for the generate data key endpoint and decrypt key endpoint. |
||||
|
||||
### Environment variables |
||||
|
||||
You'll need the Vault endpoint, AppRole ID, AppRole SecretID, encryption key-ring name before starting Minio server with Vault as KMS |
||||
|
||||
```sh |
||||
export MINIO_SSE_VAULT_APPROLE_ID=9b56cc08-8258-45d5-24a3-679876769126 |
||||
export MINIO_SSE_VAULT_APPROLE_SECRET=4e30c52f-13e4-a6f5-0763-d50e8cb4321f |
||||
export MINIO_SSE_VAULT_ENDPOINT=https://vault-endpoint-ip:8200 |
||||
export MINIO_SSE_VAULT_KEY_NAME=my-minio-key |
||||
minio server ~/export |
||||
``` |
||||
|
||||
### 4. Test your setup |
||||
|
||||
To test this setup, access the Minio server via browser or [`mc`](https://docs.minio.io/docs/minio-client-quickstart-guide). You’ll see the uploaded files are accessible from the all the Minio endpoints. |
||||
|
||||
# Explore Further |
||||
|
||||
- [Use `mc` with Minio Server](https://docs.minio.io/docs/minio-client-quickstart-guide) |
||||
- [Use `aws-cli` with Minio Server](https://docs.minio.io/docs/aws-cli-with-minio) |
||||
- [Use `s3cmd` with Minio Server](https://docs.minio.io/docs/s3cmd-with-minio) |
||||
- [Use `minio-go` SDK with Minio Server](https://docs.minio.io/docs/golang-client-quickstart-guide) |
||||
- [The Minio documentation website](https://docs.minio.io) |
||||
@ -0,0 +1,354 @@ |
||||
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. |
||||
|
||||
@ -0,0 +1,89 @@ |
||||
# 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! |
||||
} |
||||
``` |
||||
@ -0,0 +1,169 @@ |
||||
// 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} |
||||
} |
||||
@ -0,0 +1,363 @@ |
||||
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. |
||||
|
||||
@ -0,0 +1,30 @@ |
||||
# 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. |
||||
@ -0,0 +1,57 @@ |
||||
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(), |
||||
} |
||||
} |
||||
@ -0,0 +1,20 @@ |
||||
// 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 |
||||
@ -0,0 +1,43 @@ |
||||
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 |
||||
}) |
||||
} |
||||
@ -0,0 +1,353 @@ |
||||
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. |
||||
@ -0,0 +1,31 @@ |
||||
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 |
||||
@ -0,0 +1,97 @@ |
||||
# go-multierror |
||||
|
||||
[][travis] |
||||
[][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() |
||||
``` |
||||
@ -0,0 +1,41 @@ |
||||
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...) |
||||
} |
||||
} |
||||
@ -0,0 +1,26 @@ |
||||
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) |
||||
} |
||||
} |
||||
@ -0,0 +1,27 @@ |
||||
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")) |
||||
} |
||||
@ -0,0 +1,51 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,37 @@ |
||||
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) |
||||
} |
||||
} |
||||
@ -0,0 +1,16 @@ |
||||
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() |
||||
} |
||||
@ -0,0 +1,363 @@ |
||||
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. |
||||
|
||||
@ -0,0 +1,11 @@ |
||||
default: test |
||||
|
||||
test: |
||||
go vet ./...
|
||||
go test -race ./...
|
||||
|
||||
updatedeps: |
||||
go get -f -t -u ./...
|
||||
go get -f -u ./...
|
||||
|
||||
.PHONY: default test updatedeps |
||||
@ -0,0 +1,46 @@ |
||||
go-retryablehttp |
||||
================ |
||||
|
||||
[][travis] |
||||
[][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). |
||||
@ -0,0 +1,500 @@ |
||||
// 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" |
||||
|
||||
"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 |
||||
} |
||||
|
||||
// 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 |
||||
} |
||||
|
||||
// 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(*log.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(*log.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 *log.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())) |
||||
} |
||||
@ -0,0 +1,363 @@ |
||||
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. |
||||
|
||||
@ -0,0 +1,8 @@ |
||||
TEST?=./...
|
||||
|
||||
test: |
||||
go test $(TEST) $(TESTARGS) -timeout=3s -parallel=4
|
||||
go vet $(TEST)
|
||||
go test $(TEST) -race
|
||||
|
||||
.PHONY: test |
||||
@ -0,0 +1,43 @@ |
||||
# 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 |
||||
} |
||||
``` |
||||
@ -0,0 +1,9 @@ |
||||
// 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 |
||||
@ -0,0 +1,103 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,12 @@ |
||||
// +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 |
||||
} |
||||
@ -0,0 +1,48 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,65 @@ |
||||
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
|
||||
@ -0,0 +1,373 @@ |
||||
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. |
||||
@ -0,0 +1,118 @@ |
||||
# 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. |
||||
@ -0,0 +1,5 @@ |
||||
/* |
||||
Package sockaddr is a Go implementation of the UNIX socket family data types and |
||||
related helper functions. |
||||
*/ |
||||
package sockaddr |
||||
@ -0,0 +1,254 @@ |
||||
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 |
||||
}, |
||||
} |
||||
} |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,65 @@ |
||||
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) |
||||
} |
||||
@ -0,0 +1,169 @@ |
||||
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()) |
||||
}, |
||||
} |
||||
} |
||||
@ -0,0 +1,98 @@ |
||||
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() |
||||
} |
||||
@ -0,0 +1,516 @@ |
||||
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)) |
||||
}, |
||||
} |
||||
} |
||||
@ -0,0 +1,591 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,948 @@ |
||||
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) |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,19 @@ |
||||
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) |
||||
} |
||||
} |
||||
@ -0,0 +1,36 @@ |
||||
// +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 |
||||
} |
||||
@ -0,0 +1,10 @@ |
||||
// +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)") |
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,37 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,41 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,206 @@ |
||||
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 |
||||
} |
||||
@ -0,0 +1,193 @@ |
||||
package sockaddr |
||||
|
||||
import ( |
||||
"bytes" |
||||
"sort" |
||||
) |
||||
|
||||
// SockAddrs is a slice of SockAddrs
|
||||
type SockAddrs []SockAddr |
||||
|
||||
func (s SockAddrs) Len() int { return len(s) } |
||||
func (s SockAddrs) Swap(i, j int) { s[i], s[j] = s[j], s[i] } |
||||
|
||||
// CmpAddrFunc is the function signature that must be met to be used in the
|
||||
// OrderedAddrBy multiAddrSorter
|
||||
type CmpAddrFunc func(p1, p2 *SockAddr) int |
||||
|
||||
// multiAddrSorter implements the Sort interface, sorting the SockAddrs within.
|
||||
type multiAddrSorter struct { |
||||
addrs SockAddrs |
||||
cmp []CmpAddrFunc |
||||
} |
||||
|
||||
// Sort sorts the argument slice according to the Cmp functions passed to
|
||||
// OrderedAddrBy.
|
||||
func (ms *multiAddrSorter) Sort(sockAddrs SockAddrs) { |
||||
ms.addrs = sockAddrs |
||||
sort.Sort(ms) |
||||
} |
||||
|
||||
// OrderedAddrBy sorts SockAddr by the list of sort function pointers.
|
||||
func OrderedAddrBy(cmpFuncs ...CmpAddrFunc) *multiAddrSorter { |
||||
return &multiAddrSorter{ |
||||
cmp: cmpFuncs, |
||||
} |
||||
} |
||||
|
||||
// Len is part of sort.Interface.
|
||||
func (ms *multiAddrSorter) Len() int { |
||||
return len(ms.addrs) |
||||
} |
||||
|
||||
// Less is part of sort.Interface. It is implemented by looping along the
|
||||
// Cmp() functions until it finds a comparison that is either less than,
|
||||
// equal to, or greater than.
|
||||
func (ms *multiAddrSorter) Less(i, j int) bool { |
||||
p, q := &ms.addrs[i], &ms.addrs[j] |
||||
// Try all but the last comparison.
|
||||
var k int |
||||
for k = 0; k < len(ms.cmp)-1; k++ { |
||||
cmp := ms.cmp[k] |
||||
x := cmp(p, q) |
||||
switch x { |
||||
case -1: |
||||
// p < q, so we have a decision.
|
||||
return true |
||||
case 1: |
||||
// p > q, so we have a decision.
|
||||
return false |
||||
} |
||||
// p == q; try the next comparison.
|
||||
} |
||||
// All comparisons to here said "equal", so just return whatever the
|
||||
// final comparison reports.
|
||||
switch ms.cmp[k](p, q) { |
||||
case -1: |
||||
return true |
||||
case 1: |
||||
return false |
||||
default: |
||||
// Still a tie! Now what?
|
||||
return false |
||||
} |
||||
} |
||||
|
||||
// Swap is part of sort.Interface.
|
||||
func (ms *multiAddrSorter) Swap(i, j int) { |
||||
ms.addrs[i], ms.addrs[j] = ms.addrs[j], ms.addrs[i] |
||||
} |
||||
|
||||
const ( |
||||
// NOTE (sean@): These constants are here for code readability only and
|
||||
// are sprucing up the code for readability purposes. Some of the
|
||||
// Cmp*() variants have confusing logic (especially when dealing with
|
||||
// mixed-type comparisons) and this, I think, has made it easier to grok
|
||||
// the code faster.
|
||||
sortReceiverBeforeArg = -1 |
||||
sortDeferDecision = 0 |
||||
sortArgBeforeReceiver = 1 |
||||
) |
||||
|
||||
// AscAddress is a sorting function to sort SockAddrs by their respective
|
||||
// address type. Non-equal types are deferred in the sort.
|
||||
func AscAddress(p1Ptr, p2Ptr *SockAddr) int { |
||||
p1 := *p1Ptr |
||||
p2 := *p2Ptr |
||||
|
||||
switch v := p1.(type) { |
||||
case IPv4Addr: |
||||
return v.CmpAddress(p2) |
||||
case IPv6Addr: |
||||
return v.CmpAddress(p2) |
||||
case UnixSock: |
||||
return v.CmpAddress(p2) |
||||
default: |
||||
return sortDeferDecision |
||||
} |
||||
} |
||||
|
||||
// AscPort is a sorting function to sort SockAddrs by their respective address
|
||||
// type. Non-equal types are deferred in the sort.
|
||||
func AscPort(p1Ptr, p2Ptr *SockAddr) int { |
||||
p1 := *p1Ptr |
||||
p2 := *p2Ptr |
||||
|
||||
switch v := p1.(type) { |
||||
case IPv4Addr: |
||||
return v.CmpPort(p2) |
||||
case IPv6Addr: |
||||
return v.CmpPort(p2) |
||||
default: |
||||
return sortDeferDecision |
||||
} |
||||
} |
||||
|
||||
// AscPrivate is a sorting function to sort "more secure" private values before
|
||||
// "more public" values. Both IPv4 and IPv6 are compared against RFC6890
|
||||
// (RFC6890 includes, and is not limited to, RFC1918 and RFC6598 for IPv4, and
|
||||
// IPv6 includes RFC4193).
|
||||
func AscPrivate(p1Ptr, p2Ptr *SockAddr) int { |
||||
p1 := *p1Ptr |
||||
p2 := *p2Ptr |
||||
|
||||
switch v := p1.(type) { |
||||
case IPv4Addr, IPv6Addr: |
||||
return v.CmpRFC(6890, p2) |
||||
default: |
||||
return sortDeferDecision |
||||
} |
||||
} |
||||
|
||||
// AscNetworkSize is a sorting function to sort SockAddrs based on their network
|
||||
// size. Non-equal types are deferred in the sort.
|
||||
func AscNetworkSize(p1Ptr, p2Ptr *SockAddr) int { |
||||
p1 := *p1Ptr |
||||
p2 := *p2Ptr |
||||
p1Type := p1.Type() |
||||
p2Type := p2.Type() |
||||
|
||||
// Network size operations on non-IP types make no sense
|
||||
if p1Type != p2Type && p1Type != TypeIP { |
||||
return sortDeferDecision |
||||
} |
||||
|
||||
ipA := p1.(IPAddr) |
||||
ipB := p2.(IPAddr) |
||||
|
||||
return bytes.Compare([]byte(*ipA.NetIPMask()), []byte(*ipB.NetIPMask())) |
||||
} |
||||
|
||||
// AscType is a sorting function to sort "more secure" types before
|
||||
// "less-secure" types.
|
||||
func AscType(p1Ptr, p2Ptr *SockAddr) int { |
||||
p1 := *p1Ptr |
||||
p2 := *p2Ptr |
||||
p1Type := p1.Type() |
||||
p2Type := p2.Type() |
||||
switch { |
||||
case p1Type < p2Type: |
||||
return sortReceiverBeforeArg |
||||
case p1Type == p2Type: |
||||
return sortDeferDecision |
||||
case p1Type > p2Type: |
||||
return sortArgBeforeReceiver |
||||
default: |
||||
return sortDeferDecision |
||||
} |
||||
} |
||||
|
||||
// FilterByType returns two lists: a list of matched and unmatched SockAddrs
|
||||
func (sas SockAddrs) FilterByType(type_ SockAddrType) (matched, excluded SockAddrs) { |
||||
matched = make(SockAddrs, 0, len(sas)) |
||||
excluded = make(SockAddrs, 0, len(sas)) |
||||
|
||||
for _, sa := range sas { |
||||
if sa.Type()&type_ != 0 { |
||||
matched = append(matched, sa) |
||||
} else { |
||||
excluded = append(excluded, sa) |
||||
} |
||||
} |
||||
return matched, excluded |
||||
} |
||||
@ -0,0 +1,135 @@ |
||||
package sockaddr |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
) |
||||
|
||||
type UnixSock struct { |
||||
SockAddr |
||||
path string |
||||
} |
||||
type UnixSocks []*UnixSock |
||||
|
||||
// unixAttrMap is a map of the UnixSockAddr type-specific attributes.
|
||||
var unixAttrMap map[AttrName]func(UnixSock) string |
||||
var unixAttrs []AttrName |
||||
|
||||
func init() { |
||||
unixAttrInit() |
||||
} |
||||
|
||||
// NewUnixSock creates an UnixSock from a string path. String can be in the
|
||||
// form of either URI-based string (e.g. `file:///etc/passwd`), an absolute
|
||||
// path (e.g. `/etc/passwd`), or a relative path (e.g. `./foo`).
|
||||
func NewUnixSock(s string) (ret UnixSock, err error) { |
||||
ret.path = s |
||||
return ret, nil |
||||
} |
||||
|
||||
// CmpAddress follows the Cmp() standard protocol and returns:
|
||||
//
|
||||
// - -1 If the receiver should sort first because its name lexically sorts before arg
|
||||
// - 0 if the SockAddr arg is not a UnixSock, or is a UnixSock with the same path.
|
||||
// - 1 If the argument should sort first.
|
||||
func (us UnixSock) CmpAddress(sa SockAddr) int { |
||||
usb, ok := sa.(UnixSock) |
||||
if !ok { |
||||
return sortDeferDecision |
||||
} |
||||
|
||||
return strings.Compare(us.Path(), usb.Path()) |
||||
} |
||||
|
||||
// DialPacketArgs returns the arguments required to be passed to net.DialUnix()
|
||||
// with the `unixgram` network type.
|
||||
func (us UnixSock) DialPacketArgs() (network, dialArgs string) { |
||||
return "unixgram", us.path |
||||
} |
||||
|
||||
// DialStreamArgs returns the arguments required to be passed to net.DialUnix()
|
||||
// with the `unix` network type.
|
||||
func (us UnixSock) DialStreamArgs() (network, dialArgs string) { |
||||
return "unix", us.path |
||||
} |
||||
|
||||
// Equal returns true if a SockAddr is equal to the receiving UnixSock.
|
||||
func (us UnixSock) Equal(sa SockAddr) bool { |
||||
usb, ok := sa.(UnixSock) |
||||
if !ok { |
||||
return false |
||||
} |
||||
|
||||
if us.Path() != usb.Path() { |
||||
return false |
||||
} |
||||
|
||||
return true |
||||
} |
||||
|
||||
// ListenPacketArgs returns the arguments required to be passed to
|
||||
// net.ListenUnixgram() with the `unixgram` network type.
|
||||
func (us UnixSock) ListenPacketArgs() (network, dialArgs string) { |
||||
return "unixgram", us.path |
||||
} |
||||
|
||||
// ListenStreamArgs returns the arguments required to be passed to
|
||||
// net.ListenUnix() with the `unix` network type.
|
||||
func (us UnixSock) ListenStreamArgs() (network, dialArgs string) { |
||||
return "unix", us.path |
||||
} |
||||
|
||||
// MustUnixSock is a helper method that must return an UnixSock or panic on
|
||||
// invalid input.
|
||||
func MustUnixSock(addr string) UnixSock { |
||||
us, err := NewUnixSock(addr) |
||||
if err != nil { |
||||
panic(fmt.Sprintf("Unable to create a UnixSock from %+q: %v", addr, err)) |
||||
} |
||||
return us |
||||
} |
||||
|
||||
// Path returns the given path of the UnixSock
|
||||
func (us UnixSock) Path() string { |
||||
return us.path |
||||
} |
||||
|
||||
// String returns the path of the UnixSock
|
||||
func (us UnixSock) String() string { |
||||
return fmt.Sprintf("%+q", us.path) |
||||
} |
||||
|
||||
// Type is used as a type switch and returns TypeUnix
|
||||
func (UnixSock) Type() SockAddrType { |
||||
return TypeUnix |
||||
} |
||||
|
||||
// UnixSockAttrs returns a list of attributes supported by the UnixSockAddr type
|
||||
func UnixSockAttrs() []AttrName { |
||||
return unixAttrs |
||||
} |
||||
|
||||
// UnixSockAttr returns a string representation of an attribute for the given
|
||||
// UnixSock.
|
||||
func UnixSockAttr(us UnixSock, attrName AttrName) string { |
||||
fn, found := unixAttrMap[attrName] |
||||
if !found { |
||||
return "" |
||||
} |
||||
|
||||
return fn(us) |
||||
} |
||||
|
||||
// unixAttrInit is called once at init()
|
||||
func unixAttrInit() { |
||||
// Sorted for human readability
|
||||
unixAttrs = []AttrName{ |
||||
"path", |
||||
} |
||||
|
||||
unixAttrMap = map[AttrName]func(us UnixSock) string{ |
||||
"path": func(us UnixSock) string { |
||||
return us.Path() |
||||
}, |
||||
} |
||||
} |
||||
@ -0,0 +1,354 @@ |
||||
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. |
||||
|
||||
@ -0,0 +1,18 @@ |
||||
TEST?=./...
|
||||
|
||||
default: test |
||||
|
||||
fmt: generate |
||||
go fmt ./...
|
||||
|
||||
test: generate |
||||
go get -t ./...
|
||||
go test $(TEST) $(TESTARGS)
|
||||
|
||||
generate: |
||||
go generate ./...
|
||||
|
||||
updatedeps: |
||||
go get -u golang.org/x/tools/cmd/stringer
|
||||
|
||||
.PHONY: default generate test updatedeps |
||||
@ -0,0 +1,125 @@ |
||||
# HCL |
||||
|
||||
[](https://godoc.org/github.com/hashicorp/hcl) [](https://travis-ci.org/hashicorp/hcl) |
||||
|
||||
HCL (HashiCorp Configuration Language) is a configuration language built |
||||
by HashiCorp. The goal of HCL is to build a structured configuration language |
||||
that is both human and machine friendly for use with command-line tools, but |
||||
specifically targeted towards DevOps tools, servers, etc. |
||||
|
||||
HCL is also fully JSON compatible. That is, JSON can be used as completely |
||||
valid input to a system expecting HCL. This helps makes systems |
||||
interoperable with other systems. |
||||
|
||||
HCL is heavily inspired by |
||||
[libucl](https://github.com/vstakhov/libucl), |
||||
nginx configuration, and others similar. |
||||
|
||||
## Why? |
||||
|
||||
A common question when viewing HCL is to ask the question: why not |
||||
JSON, YAML, etc.? |
||||
|
||||
Prior to HCL, the tools we built at [HashiCorp](http://www.hashicorp.com) |
||||
used a variety of configuration languages from full programming languages |
||||
such as Ruby to complete data structure languages such as JSON. What we |
||||
learned is that some people wanted human-friendly configuration languages |
||||
and some people wanted machine-friendly languages. |
||||
|
||||
JSON fits a nice balance in this, but is fairly verbose and most |
||||
importantly doesn't support comments. With YAML, we found that beginners |
||||
had a really hard time determining what the actual structure was, and |
||||
ended up guessing more often than not whether to use a hyphen, colon, etc. |
||||
in order to represent some configuration key. |
||||
|
||||
Full programming languages such as Ruby enable complex behavior |
||||
a configuration language shouldn't usually allow, and also forces |
||||
people to learn some set of Ruby. |
||||
|
||||
Because of this, we decided to create our own configuration language |
||||
that is JSON-compatible. Our configuration language (HCL) is designed |
||||
to be written and modified by humans. The API for HCL allows JSON |
||||
as an input so that it is also machine-friendly (machines can generate |
||||
JSON instead of trying to generate HCL). |
||||
|
||||
Our goal with HCL is not to alienate other configuration languages. |
||||
It is instead to provide HCL as a specialized language for our tools, |
||||
and JSON as the interoperability layer. |
||||
|
||||
## Syntax |
||||
|
||||
For a complete grammar, please see the parser itself. A high-level overview |
||||
of the syntax and grammar is listed here. |
||||
|
||||
* Single line comments start with `#` or `//` |
||||
|
||||
* Multi-line comments are wrapped in `/*` and `*/`. Nested block comments |
||||
are not allowed. A multi-line comment (also known as a block comment) |
||||
terminates at the first `*/` found. |
||||
|
||||
* Values are assigned with the syntax `key = value` (whitespace doesn't |
||||
matter). The value can be any primitive: a string, number, boolean, |
||||
object, or list. |
||||
|
||||
* Strings are double-quoted and can contain any UTF-8 characters. |
||||
Example: `"Hello, World"` |
||||
|
||||
* Multi-line strings start with `<<EOF` at the end of a line, and end |
||||
with `EOF` on its own line ([here documents](https://en.wikipedia.org/wiki/Here_document)). |
||||
Any text may be used in place of `EOF`. Example: |
||||
``` |
||||
<<FOO |
||||
hello |
||||
world |
||||
FOO |
||||
``` |
||||
|
||||
* Numbers are assumed to be base 10. If you prefix a number with 0x, |
||||
it is treated as a hexadecimal. If it is prefixed with 0, it is |
||||
treated as an octal. Numbers can be in scientific notation: "1e10". |
||||
|
||||
* Boolean values: `true`, `false` |
||||
|
||||
* Arrays can be made by wrapping it in `[]`. Example: |
||||
`["foo", "bar", 42]`. Arrays can contain primitives, |
||||
other arrays, and objects. As an alternative, lists |
||||
of objects can be created with repeated blocks, using |
||||
this structure: |
||||
|
||||
```hcl |
||||
service { |
||||
key = "value" |
||||
} |
||||
|
||||
service { |
||||
key = "value" |
||||
} |
||||
``` |
||||
|
||||
Objects and nested objects are created using the structure shown below: |
||||
|
||||
``` |
||||
variable "ami" { |
||||
description = "the AMI to use" |
||||
} |
||||
``` |
||||
This would be equivalent to the following json: |
||||
``` json |
||||
{ |
||||
"variable": { |
||||
"ami": { |
||||
"description": "the AMI to use" |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
## Thanks |
||||
|
||||
Thanks to: |
||||
|
||||
* [@vstakhov](https://github.com/vstakhov) - The original libucl parser |
||||
and syntax that HCL was based off of. |
||||
|
||||
* [@fatih](https://github.com/fatih) - The rewritten HCL parser |
||||
in pure Go (no goyacc) and support for a printer. |
||||
@ -0,0 +1,19 @@ |
||||
version: "build-{branch}-{build}" |
||||
image: Visual Studio 2015 |
||||
clone_folder: c:\gopath\src\github.com\hashicorp\hcl |
||||
environment: |
||||
GOPATH: c:\gopath |
||||
init: |
||||
- git config --global core.autocrlf false |
||||
install: |
||||
- cmd: >- |
||||
echo %Path% |
||||
|
||||
go version |
||||
|
||||
go env |
||||
|
||||
go get -t ./... |
||||
|
||||
build_script: |
||||
- cmd: go test -v ./... |
||||
@ -0,0 +1,729 @@ |
||||
package hcl |
||||
|
||||
import ( |
||||
"errors" |
||||
"fmt" |
||||
"reflect" |
||||
"sort" |
||||
"strconv" |
||||
"strings" |
||||
|
||||
"github.com/hashicorp/hcl/hcl/ast" |
||||
"github.com/hashicorp/hcl/hcl/parser" |
||||
"github.com/hashicorp/hcl/hcl/token" |
||||
) |
||||
|
||||
// This is the tag to use with structures to have settings for HCL
|
||||
const tagName = "hcl" |
||||
|
||||
var ( |
||||
// nodeType holds a reference to the type of ast.Node
|
||||
nodeType reflect.Type = findNodeType() |
||||
) |
||||
|
||||
// Unmarshal accepts a byte slice as input and writes the
|
||||
// data to the value pointed to by v.
|
||||
func Unmarshal(bs []byte, v interface{}) error { |
||||
root, err := parse(bs) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
return DecodeObject(v, root) |
||||
} |
||||
|
||||
// Decode reads the given input and decodes it into the structure
|
||||
// given by `out`.
|
||||
func Decode(out interface{}, in string) error { |
||||
obj, err := Parse(in) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
return DecodeObject(out, obj) |
||||
} |
||||
|
||||
// DecodeObject is a lower-level version of Decode. It decodes a
|
||||
// raw Object into the given output.
|
||||
func DecodeObject(out interface{}, n ast.Node) error { |
||||
val := reflect.ValueOf(out) |
||||
if val.Kind() != reflect.Ptr { |
||||
return errors.New("result must be a pointer") |
||||
} |
||||
|
||||
// If we have the file, we really decode the root node
|
||||
if f, ok := n.(*ast.File); ok { |
||||
n = f.Node |
||||
} |
||||
|
||||
var d decoder |
||||
return d.decode("root", n, val.Elem()) |
||||
} |
||||
|
||||
type decoder struct { |
||||
stack []reflect.Kind |
||||
} |
||||
|
||||
func (d *decoder) decode(name string, node ast.Node, result reflect.Value) error { |
||||
k := result |
||||
|
||||
// If we have an interface with a valid value, we use that
|
||||
// for the check.
|
||||
if result.Kind() == reflect.Interface { |
||||
elem := result.Elem() |
||||
if elem.IsValid() { |
||||
k = elem |
||||
} |
||||
} |
||||
|
||||
// Push current onto stack unless it is an interface.
|
||||
if k.Kind() != reflect.Interface { |
||||
d.stack = append(d.stack, k.Kind()) |
||||
|
||||
// Schedule a pop
|
||||
defer func() { |
||||
d.stack = d.stack[:len(d.stack)-1] |
||||
}() |
||||
} |
||||
|
||||
switch k.Kind() { |
||||
case reflect.Bool: |
||||
return d.decodeBool(name, node, result) |
||||
case reflect.Float32, reflect.Float64: |
||||
return d.decodeFloat(name, node, result) |
||||
case reflect.Int, reflect.Int32, reflect.Int64: |
||||
return d.decodeInt(name, node, result) |
||||
case reflect.Interface: |
||||
// When we see an interface, we make our own thing
|
||||
return d.decodeInterface(name, node, result) |
||||
case reflect.Map: |
||||
return d.decodeMap(name, node, result) |
||||
case reflect.Ptr: |
||||
return d.decodePtr(name, node, result) |
||||
case reflect.Slice: |
||||
return d.decodeSlice(name, node, result) |
||||
case reflect.String: |
||||
return d.decodeString(name, node, result) |
||||
case reflect.Struct: |
||||
return d.decodeStruct(name, node, result) |
||||
default: |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unknown kind to decode into: %s", name, k.Kind()), |
||||
} |
||||
} |
||||
} |
||||
|
||||
func (d *decoder) decodeBool(name string, node ast.Node, result reflect.Value) error { |
||||
switch n := node.(type) { |
||||
case *ast.LiteralType: |
||||
if n.Token.Type == token.BOOL { |
||||
v, err := strconv.ParseBool(n.Token.Text) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
result.Set(reflect.ValueOf(v)) |
||||
return nil |
||||
} |
||||
} |
||||
|
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unknown type %T", name, node), |
||||
} |
||||
} |
||||
|
||||
func (d *decoder) decodeFloat(name string, node ast.Node, result reflect.Value) error { |
||||
switch n := node.(type) { |
||||
case *ast.LiteralType: |
||||
if n.Token.Type == token.FLOAT || n.Token.Type == token.NUMBER { |
||||
v, err := strconv.ParseFloat(n.Token.Text, 64) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
result.Set(reflect.ValueOf(v).Convert(result.Type())) |
||||
return nil |
||||
} |
||||
} |
||||
|
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unknown type %T", name, node), |
||||
} |
||||
} |
||||
|
||||
func (d *decoder) decodeInt(name string, node ast.Node, result reflect.Value) error { |
||||
switch n := node.(type) { |
||||
case *ast.LiteralType: |
||||
switch n.Token.Type { |
||||
case token.NUMBER: |
||||
v, err := strconv.ParseInt(n.Token.Text, 0, 0) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
if result.Kind() == reflect.Interface { |
||||
result.Set(reflect.ValueOf(int(v))) |
||||
} else { |
||||
result.SetInt(v) |
||||
} |
||||
return nil |
||||
case token.STRING: |
||||
v, err := strconv.ParseInt(n.Token.Value().(string), 0, 0) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
if result.Kind() == reflect.Interface { |
||||
result.Set(reflect.ValueOf(int(v))) |
||||
} else { |
||||
result.SetInt(v) |
||||
} |
||||
return nil |
||||
} |
||||
} |
||||
|
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unknown type %T", name, node), |
||||
} |
||||
} |
||||
|
||||
func (d *decoder) decodeInterface(name string, node ast.Node, result reflect.Value) error { |
||||
// When we see an ast.Node, we retain the value to enable deferred decoding.
|
||||
// Very useful in situations where we want to preserve ast.Node information
|
||||
// like Pos
|
||||
if result.Type() == nodeType && result.CanSet() { |
||||
result.Set(reflect.ValueOf(node)) |
||||
return nil |
||||
} |
||||
|
||||
var set reflect.Value |
||||
redecode := true |
||||
|
||||
// For testing types, ObjectType should just be treated as a list. We
|
||||
// set this to a temporary var because we want to pass in the real node.
|
||||
testNode := node |
||||
if ot, ok := node.(*ast.ObjectType); ok { |
||||
testNode = ot.List |
||||
} |
||||
|
||||
switch n := testNode.(type) { |
||||
case *ast.ObjectList: |
||||
// If we're at the root or we're directly within a slice, then we
|
||||
// decode objects into map[string]interface{}, otherwise we decode
|
||||
// them into lists.
|
||||
if len(d.stack) == 0 || d.stack[len(d.stack)-1] == reflect.Slice { |
||||
var temp map[string]interface{} |
||||
tempVal := reflect.ValueOf(temp) |
||||
result := reflect.MakeMap( |
||||
reflect.MapOf( |
||||
reflect.TypeOf(""), |
||||
tempVal.Type().Elem())) |
||||
|
||||
set = result |
||||
} else { |
||||
var temp []map[string]interface{} |
||||
tempVal := reflect.ValueOf(temp) |
||||
result := reflect.MakeSlice( |
||||
reflect.SliceOf(tempVal.Type().Elem()), 0, len(n.Items)) |
||||
set = result |
||||
} |
||||
case *ast.ObjectType: |
||||
// If we're at the root or we're directly within a slice, then we
|
||||
// decode objects into map[string]interface{}, otherwise we decode
|
||||
// them into lists.
|
||||
if len(d.stack) == 0 || d.stack[len(d.stack)-1] == reflect.Slice { |
||||
var temp map[string]interface{} |
||||
tempVal := reflect.ValueOf(temp) |
||||
result := reflect.MakeMap( |
||||
reflect.MapOf( |
||||
reflect.TypeOf(""), |
||||
tempVal.Type().Elem())) |
||||
|
||||
set = result |
||||
} else { |
||||
var temp []map[string]interface{} |
||||
tempVal := reflect.ValueOf(temp) |
||||
result := reflect.MakeSlice( |
||||
reflect.SliceOf(tempVal.Type().Elem()), 0, 1) |
||||
set = result |
||||
} |
||||
case *ast.ListType: |
||||
var temp []interface{} |
||||
tempVal := reflect.ValueOf(temp) |
||||
result := reflect.MakeSlice( |
||||
reflect.SliceOf(tempVal.Type().Elem()), 0, 0) |
||||
set = result |
||||
case *ast.LiteralType: |
||||
switch n.Token.Type { |
||||
case token.BOOL: |
||||
var result bool |
||||
set = reflect.Indirect(reflect.New(reflect.TypeOf(result))) |
||||
case token.FLOAT: |
||||
var result float64 |
||||
set = reflect.Indirect(reflect.New(reflect.TypeOf(result))) |
||||
case token.NUMBER: |
||||
var result int |
||||
set = reflect.Indirect(reflect.New(reflect.TypeOf(result))) |
||||
case token.STRING, token.HEREDOC: |
||||
set = reflect.Indirect(reflect.New(reflect.TypeOf(""))) |
||||
default: |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: cannot decode into interface: %T", name, node), |
||||
} |
||||
} |
||||
default: |
||||
return fmt.Errorf( |
||||
"%s: cannot decode into interface: %T", |
||||
name, node) |
||||
} |
||||
|
||||
// Set the result to what its supposed to be, then reset
|
||||
// result so we don't reflect into this method anymore.
|
||||
result.Set(set) |
||||
|
||||
if redecode { |
||||
// Revisit the node so that we can use the newly instantiated
|
||||
// thing and populate it.
|
||||
if err := d.decode(name, node, result); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func (d *decoder) decodeMap(name string, node ast.Node, result reflect.Value) error { |
||||
if item, ok := node.(*ast.ObjectItem); ok { |
||||
node = &ast.ObjectList{Items: []*ast.ObjectItem{item}} |
||||
} |
||||
|
||||
if ot, ok := node.(*ast.ObjectType); ok { |
||||
node = ot.List |
||||
} |
||||
|
||||
n, ok := node.(*ast.ObjectList) |
||||
if !ok { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: not an object type for map (%T)", name, node), |
||||
} |
||||
} |
||||
|
||||
// If we have an interface, then we can address the interface,
|
||||
// but not the slice itself, so get the element but set the interface
|
||||
set := result |
||||
if result.Kind() == reflect.Interface { |
||||
result = result.Elem() |
||||
} |
||||
|
||||
resultType := result.Type() |
||||
resultElemType := resultType.Elem() |
||||
resultKeyType := resultType.Key() |
||||
if resultKeyType.Kind() != reflect.String { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: map must have string keys", name), |
||||
} |
||||
} |
||||
|
||||
// Make a map if it is nil
|
||||
resultMap := result |
||||
if result.IsNil() { |
||||
resultMap = reflect.MakeMap( |
||||
reflect.MapOf(resultKeyType, resultElemType)) |
||||
} |
||||
|
||||
// Go through each element and decode it.
|
||||
done := make(map[string]struct{}) |
||||
for _, item := range n.Items { |
||||
if item.Val == nil { |
||||
continue |
||||
} |
||||
|
||||
// github.com/hashicorp/terraform/issue/5740
|
||||
if len(item.Keys) == 0 { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: map must have string keys", name), |
||||
} |
||||
} |
||||
|
||||
// Get the key we're dealing with, which is the first item
|
||||
keyStr := item.Keys[0].Token.Value().(string) |
||||
|
||||
// If we've already processed this key, then ignore it
|
||||
if _, ok := done[keyStr]; ok { |
||||
continue |
||||
} |
||||
|
||||
// Determine the value. If we have more than one key, then we
|
||||
// get the objectlist of only these keys.
|
||||
itemVal := item.Val |
||||
if len(item.Keys) > 1 { |
||||
itemVal = n.Filter(keyStr) |
||||
done[keyStr] = struct{}{} |
||||
} |
||||
|
||||
// Make the field name
|
||||
fieldName := fmt.Sprintf("%s.%s", name, keyStr) |
||||
|
||||
// Get the key/value as reflection values
|
||||
key := reflect.ValueOf(keyStr) |
||||
val := reflect.Indirect(reflect.New(resultElemType)) |
||||
|
||||
// If we have a pre-existing value in the map, use that
|
||||
oldVal := resultMap.MapIndex(key) |
||||
if oldVal.IsValid() { |
||||
val.Set(oldVal) |
||||
} |
||||
|
||||
// Decode!
|
||||
if err := d.decode(fieldName, itemVal, val); err != nil { |
||||
return err |
||||
} |
||||
|
||||
// Set the value on the map
|
||||
resultMap.SetMapIndex(key, val) |
||||
} |
||||
|
||||
// Set the final map if we can
|
||||
set.Set(resultMap) |
||||
return nil |
||||
} |
||||
|
||||
func (d *decoder) decodePtr(name string, node ast.Node, result reflect.Value) error { |
||||
// Create an element of the concrete (non pointer) type and decode
|
||||
// into that. Then set the value of the pointer to this type.
|
||||
resultType := result.Type() |
||||
resultElemType := resultType.Elem() |
||||
val := reflect.New(resultElemType) |
||||
if err := d.decode(name, node, reflect.Indirect(val)); err != nil { |
||||
return err |
||||
} |
||||
|
||||
result.Set(val) |
||||
return nil |
||||
} |
||||
|
||||
func (d *decoder) decodeSlice(name string, node ast.Node, result reflect.Value) error { |
||||
// If we have an interface, then we can address the interface,
|
||||
// but not the slice itself, so get the element but set the interface
|
||||
set := result |
||||
if result.Kind() == reflect.Interface { |
||||
result = result.Elem() |
||||
} |
||||
// Create the slice if it isn't nil
|
||||
resultType := result.Type() |
||||
resultElemType := resultType.Elem() |
||||
if result.IsNil() { |
||||
resultSliceType := reflect.SliceOf(resultElemType) |
||||
result = reflect.MakeSlice( |
||||
resultSliceType, 0, 0) |
||||
} |
||||
|
||||
// Figure out the items we'll be copying into the slice
|
||||
var items []ast.Node |
||||
switch n := node.(type) { |
||||
case *ast.ObjectList: |
||||
items = make([]ast.Node, len(n.Items)) |
||||
for i, item := range n.Items { |
||||
items[i] = item |
||||
} |
||||
case *ast.ObjectType: |
||||
items = []ast.Node{n} |
||||
case *ast.ListType: |
||||
items = n.List |
||||
default: |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("unknown slice type: %T", node), |
||||
} |
||||
} |
||||
|
||||
for i, item := range items { |
||||
fieldName := fmt.Sprintf("%s[%d]", name, i) |
||||
|
||||
// Decode
|
||||
val := reflect.Indirect(reflect.New(resultElemType)) |
||||
|
||||
// if item is an object that was decoded from ambiguous JSON and
|
||||
// flattened, make sure it's expanded if it needs to decode into a
|
||||
// defined structure.
|
||||
item := expandObject(item, val) |
||||
|
||||
if err := d.decode(fieldName, item, val); err != nil { |
||||
return err |
||||
} |
||||
|
||||
// Append it onto the slice
|
||||
result = reflect.Append(result, val) |
||||
} |
||||
|
||||
set.Set(result) |
||||
return nil |
||||
} |
||||
|
||||
// expandObject detects if an ambiguous JSON object was flattened to a List which
|
||||
// should be decoded into a struct, and expands the ast to properly deocode.
|
||||
func expandObject(node ast.Node, result reflect.Value) ast.Node { |
||||
item, ok := node.(*ast.ObjectItem) |
||||
if !ok { |
||||
return node |
||||
} |
||||
|
||||
elemType := result.Type() |
||||
|
||||
// our target type must be a struct
|
||||
switch elemType.Kind() { |
||||
case reflect.Ptr: |
||||
switch elemType.Elem().Kind() { |
||||
case reflect.Struct: |
||||
//OK
|
||||
default: |
||||
return node |
||||
} |
||||
case reflect.Struct: |
||||
//OK
|
||||
default: |
||||
return node |
||||
} |
||||
|
||||
// A list value will have a key and field name. If it had more fields,
|
||||
// it wouldn't have been flattened.
|
||||
if len(item.Keys) != 2 { |
||||
return node |
||||
} |
||||
|
||||
keyToken := item.Keys[0].Token |
||||
item.Keys = item.Keys[1:] |
||||
|
||||
// we need to un-flatten the ast enough to decode
|
||||
newNode := &ast.ObjectItem{ |
||||
Keys: []*ast.ObjectKey{ |
||||
&ast.ObjectKey{ |
||||
Token: keyToken, |
||||
}, |
||||
}, |
||||
Val: &ast.ObjectType{ |
||||
List: &ast.ObjectList{ |
||||
Items: []*ast.ObjectItem{item}, |
||||
}, |
||||
}, |
||||
} |
||||
|
||||
return newNode |
||||
} |
||||
|
||||
func (d *decoder) decodeString(name string, node ast.Node, result reflect.Value) error { |
||||
switch n := node.(type) { |
||||
case *ast.LiteralType: |
||||
switch n.Token.Type { |
||||
case token.NUMBER: |
||||
result.Set(reflect.ValueOf(n.Token.Text).Convert(result.Type())) |
||||
return nil |
||||
case token.STRING, token.HEREDOC: |
||||
result.Set(reflect.ValueOf(n.Token.Value()).Convert(result.Type())) |
||||
return nil |
||||
} |
||||
} |
||||
|
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unknown type for string %T", name, node), |
||||
} |
||||
} |
||||
|
||||
func (d *decoder) decodeStruct(name string, node ast.Node, result reflect.Value) error { |
||||
var item *ast.ObjectItem |
||||
if it, ok := node.(*ast.ObjectItem); ok { |
||||
item = it |
||||
node = it.Val |
||||
} |
||||
|
||||
if ot, ok := node.(*ast.ObjectType); ok { |
||||
node = ot.List |
||||
} |
||||
|
||||
// Handle the special case where the object itself is a literal. Previously
|
||||
// the yacc parser would always ensure top-level elements were arrays. The new
|
||||
// parser does not make the same guarantees, thus we need to convert any
|
||||
// top-level literal elements into a list.
|
||||
if _, ok := node.(*ast.LiteralType); ok && item != nil { |
||||
node = &ast.ObjectList{Items: []*ast.ObjectItem{item}} |
||||
} |
||||
|
||||
list, ok := node.(*ast.ObjectList) |
||||
if !ok { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: not an object type for struct (%T)", name, node), |
||||
} |
||||
} |
||||
|
||||
// This slice will keep track of all the structs we'll be decoding.
|
||||
// There can be more than one struct if there are embedded structs
|
||||
// that are squashed.
|
||||
structs := make([]reflect.Value, 1, 5) |
||||
structs[0] = result |
||||
|
||||
// Compile the list of all the fields that we're going to be decoding
|
||||
// from all the structs.
|
||||
type field struct { |
||||
field reflect.StructField |
||||
val reflect.Value |
||||
} |
||||
fields := []field{} |
||||
for len(structs) > 0 { |
||||
structVal := structs[0] |
||||
structs = structs[1:] |
||||
|
||||
structType := structVal.Type() |
||||
for i := 0; i < structType.NumField(); i++ { |
||||
fieldType := structType.Field(i) |
||||
tagParts := strings.Split(fieldType.Tag.Get(tagName), ",") |
||||
|
||||
// Ignore fields with tag name "-"
|
||||
if tagParts[0] == "-" { |
||||
continue |
||||
} |
||||
|
||||
if fieldType.Anonymous { |
||||
fieldKind := fieldType.Type.Kind() |
||||
if fieldKind != reflect.Struct { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: unsupported type to struct: %s", |
||||
fieldType.Name, fieldKind), |
||||
} |
||||
} |
||||
|
||||
// We have an embedded field. We "squash" the fields down
|
||||
// if specified in the tag.
|
||||
squash := false |
||||
for _, tag := range tagParts[1:] { |
||||
if tag == "squash" { |
||||
squash = true |
||||
break |
||||
} |
||||
} |
||||
|
||||
if squash { |
||||
structs = append( |
||||
structs, result.FieldByName(fieldType.Name)) |
||||
continue |
||||
} |
||||
} |
||||
|
||||
// Normal struct field, store it away
|
||||
fields = append(fields, field{fieldType, structVal.Field(i)}) |
||||
} |
||||
} |
||||
|
||||
usedKeys := make(map[string]struct{}) |
||||
decodedFields := make([]string, 0, len(fields)) |
||||
decodedFieldsVal := make([]reflect.Value, 0) |
||||
unusedKeysVal := make([]reflect.Value, 0) |
||||
for _, f := range fields { |
||||
field, fieldValue := f.field, f.val |
||||
if !fieldValue.IsValid() { |
||||
// This should never happen
|
||||
panic("field is not valid") |
||||
} |
||||
|
||||
// If we can't set the field, then it is unexported or something,
|
||||
// and we just continue onwards.
|
||||
if !fieldValue.CanSet() { |
||||
continue |
||||
} |
||||
|
||||
fieldName := field.Name |
||||
|
||||
tagValue := field.Tag.Get(tagName) |
||||
tagParts := strings.SplitN(tagValue, ",", 2) |
||||
if len(tagParts) >= 2 { |
||||
switch tagParts[1] { |
||||
case "decodedFields": |
||||
decodedFieldsVal = append(decodedFieldsVal, fieldValue) |
||||
continue |
||||
case "key": |
||||
if item == nil { |
||||
return &parser.PosError{ |
||||
Pos: node.Pos(), |
||||
Err: fmt.Errorf("%s: %s asked for 'key', impossible", |
||||
name, fieldName), |
||||
} |
||||
} |
||||
|
||||
fieldValue.SetString(item.Keys[0].Token.Value().(string)) |
||||
continue |
||||
case "unusedKeys": |
||||
unusedKeysVal = append(unusedKeysVal, fieldValue) |
||||
continue |
||||
} |
||||
} |
||||
|
||||
if tagParts[0] != "" { |
||||
fieldName = tagParts[0] |
||||
} |
||||
|
||||
// Determine the element we'll use to decode. If it is a single
|
||||
// match (only object with the field), then we decode it exactly.
|
||||
// If it is a prefix match, then we decode the matches.
|
||||
filter := list.Filter(fieldName) |
||||
|
||||
prefixMatches := filter.Children() |
||||
matches := filter.Elem() |
||||
if len(matches.Items) == 0 && len(prefixMatches.Items) == 0 { |
||||
continue |
||||
} |
||||
|
||||
// Track the used key
|
||||
usedKeys[fieldName] = struct{}{} |
||||
|
||||
// Create the field name and decode. We range over the elements
|
||||
// because we actually want the value.
|
||||
fieldName = fmt.Sprintf("%s.%s", name, fieldName) |
||||
if len(prefixMatches.Items) > 0 { |
||||
if err := d.decode(fieldName, prefixMatches, fieldValue); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
for _, match := range matches.Items { |
||||
var decodeNode ast.Node = match.Val |
||||
if ot, ok := decodeNode.(*ast.ObjectType); ok { |
||||
decodeNode = &ast.ObjectList{Items: ot.List.Items} |
||||
} |
||||
|
||||
if err := d.decode(fieldName, decodeNode, fieldValue); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
|
||||
decodedFields = append(decodedFields, field.Name) |
||||
} |
||||
|
||||
if len(decodedFieldsVal) > 0 { |
||||
// Sort it so that it is deterministic
|
||||
sort.Strings(decodedFields) |
||||
|
||||
for _, v := range decodedFieldsVal { |
||||
v.Set(reflect.ValueOf(decodedFields)) |
||||
} |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// findNodeType returns the type of ast.Node
|
||||
func findNodeType() reflect.Type { |
||||
var nodeContainer struct { |
||||
Node ast.Node |
||||
} |
||||
value := reflect.ValueOf(nodeContainer).FieldByName("Node") |
||||
return value.Type() |
||||
} |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,11 @@ |
||||
// Package hcl decodes HCL into usable Go structures.
|
||||
//
|
||||
// hcl input can come in either pure HCL format or JSON format.
|
||||
// It can be parsed into an AST, and then decoded into a structure,
|
||||
// or it can be decoded directly from a string into a structure.
|
||||
//
|
||||
// If you choose to parse HCL into a raw AST, the benefit is that you
|
||||
// can write custom visitor implementations to implement custom
|
||||
// semantic checks. By default, HCL does not perform any semantic
|
||||
// checks.
|
||||
package hcl |
||||
@ -0,0 +1,219 @@ |
||||
// Package ast declares the types used to represent syntax trees for HCL
|
||||
// (HashiCorp Configuration Language)
|
||||
package ast |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
|
||||
"github.com/hashicorp/hcl/hcl/token" |
||||
) |
||||
|
||||
// Node is an element in the abstract syntax tree.
|
||||
type Node interface { |
||||
node() |
||||
Pos() token.Pos |
||||
} |
||||
|
||||
func (File) node() {} |
||||
func (ObjectList) node() {} |
||||
func (ObjectKey) node() {} |
||||
func (ObjectItem) node() {} |
||||
func (Comment) node() {} |
||||
func (CommentGroup) node() {} |
||||
func (ObjectType) node() {} |
||||
func (LiteralType) node() {} |
||||
func (ListType) node() {} |
||||
|
||||
// File represents a single HCL file
|
||||
type File struct { |
||||
Node Node // usually a *ObjectList
|
||||
Comments []*CommentGroup // list of all comments in the source
|
||||
} |
||||
|
||||
func (f *File) Pos() token.Pos { |
||||
return f.Node.Pos() |
||||
} |
||||
|
||||
// ObjectList represents a list of ObjectItems. An HCL file itself is an
|
||||
// ObjectList.
|
||||
type ObjectList struct { |
||||
Items []*ObjectItem |
||||
} |
||||
|
||||
func (o *ObjectList) Add(item *ObjectItem) { |
||||
o.Items = append(o.Items, item) |
||||
} |
||||
|
||||
// Filter filters out the objects with the given key list as a prefix.
|
||||
//
|
||||
// The returned list of objects contain ObjectItems where the keys have
|
||||
// this prefix already stripped off. This might result in objects with
|
||||
// zero-length key lists if they have no children.
|
||||
//
|
||||
// If no matches are found, an empty ObjectList (non-nil) is returned.
|
||||
func (o *ObjectList) Filter(keys ...string) *ObjectList { |
||||
var result ObjectList |
||||
for _, item := range o.Items { |
||||
// If there aren't enough keys, then ignore this
|
||||
if len(item.Keys) < len(keys) { |
||||
continue |
||||
} |
||||
|
||||
match := true |
||||
for i, key := range item.Keys[:len(keys)] { |
||||
key := key.Token.Value().(string) |
||||
if key != keys[i] && !strings.EqualFold(key, keys[i]) { |
||||
match = false |
||||
break |
||||
} |
||||
} |
||||
if !match { |
||||
continue |
||||
} |
||||
|
||||
// Strip off the prefix from the children
|
||||
newItem := *item |
||||
newItem.Keys = newItem.Keys[len(keys):] |
||||
result.Add(&newItem) |
||||
} |
||||
|
||||
return &result |
||||
} |
||||
|
||||
// Children returns further nested objects (key length > 0) within this
|
||||
// ObjectList. This should be used with Filter to get at child items.
|
||||
func (o *ObjectList) Children() *ObjectList { |
||||
var result ObjectList |
||||
for _, item := range o.Items { |
||||
if len(item.Keys) > 0 { |
||||
result.Add(item) |
||||
} |
||||
} |
||||
|
||||
return &result |
||||
} |
||||
|
||||
// Elem returns items in the list that are direct element assignments
|
||||
// (key length == 0). This should be used with Filter to get at elements.
|
||||
func (o *ObjectList) Elem() *ObjectList { |
||||
var result ObjectList |
||||
for _, item := range o.Items { |
||||
if len(item.Keys) == 0 { |
||||
result.Add(item) |
||||
} |
||||
} |
||||
|
||||
return &result |
||||
} |
||||
|
||||
func (o *ObjectList) Pos() token.Pos { |
||||
// always returns the uninitiliazed position
|
||||
return o.Items[0].Pos() |
||||
} |
||||
|
||||
// ObjectItem represents a HCL Object Item. An item is represented with a key
|
||||
// (or keys). It can be an assignment or an object (both normal and nested)
|
||||
type ObjectItem struct { |
||||
// keys is only one length long if it's of type assignment. If it's a
|
||||
// nested object it can be larger than one. In that case "assign" is
|
||||
// invalid as there is no assignments for a nested object.
|
||||
Keys []*ObjectKey |
||||
|
||||
// assign contains the position of "=", if any
|
||||
Assign token.Pos |
||||
|
||||
// val is the item itself. It can be an object,list, number, bool or a
|
||||
// string. If key length is larger than one, val can be only of type
|
||||
// Object.
|
||||
Val Node |
||||
|
||||
LeadComment *CommentGroup // associated lead comment
|
||||
LineComment *CommentGroup // associated line comment
|
||||
} |
||||
|
||||
func (o *ObjectItem) Pos() token.Pos { |
||||
// I'm not entirely sure what causes this, but removing this causes
|
||||
// a test failure. We should investigate at some point.
|
||||
if len(o.Keys) == 0 { |
||||
return token.Pos{} |
||||
} |
||||
|
||||
return o.Keys[0].Pos() |
||||
} |
||||
|
||||
// ObjectKeys are either an identifier or of type string.
|
||||
type ObjectKey struct { |
||||
Token token.Token |
||||
} |
||||
|
||||
func (o *ObjectKey) Pos() token.Pos { |
||||
return o.Token.Pos |
||||
} |
||||
|
||||
// LiteralType represents a literal of basic type. Valid types are:
|
||||
// token.NUMBER, token.FLOAT, token.BOOL and token.STRING
|
||||
type LiteralType struct { |
||||
Token token.Token |
||||
|
||||
// comment types, only used when in a list
|
||||
LeadComment *CommentGroup |
||||
LineComment *CommentGroup |
||||
} |
||||
|
||||
func (l *LiteralType) Pos() token.Pos { |
||||
return l.Token.Pos |
||||
} |
||||
|
||||
// ListStatement represents a HCL List type
|
||||
type ListType struct { |
||||
Lbrack token.Pos // position of "["
|
||||
Rbrack token.Pos // position of "]"
|
||||
List []Node // the elements in lexical order
|
||||
} |
||||
|
||||
func (l *ListType) Pos() token.Pos { |
||||
return l.Lbrack |
||||
} |
||||
|
||||
func (l *ListType) Add(node Node) { |
||||
l.List = append(l.List, node) |
||||
} |
||||
|
||||
// ObjectType represents a HCL Object Type
|
||||
type ObjectType struct { |
||||
Lbrace token.Pos // position of "{"
|
||||
Rbrace token.Pos // position of "}"
|
||||
List *ObjectList // the nodes in lexical order
|
||||
} |
||||
|
||||
func (o *ObjectType) Pos() token.Pos { |
||||
return o.Lbrace |
||||
} |
||||
|
||||
// Comment node represents a single //, # style or /*- style commment
|
||||
type Comment struct { |
||||
Start token.Pos // position of / or #
|
||||
Text string |
||||
} |
||||
|
||||
func (c *Comment) Pos() token.Pos { |
||||
return c.Start |
||||
} |
||||
|
||||
// CommentGroup node represents a sequence of comments with no other tokens and
|
||||
// no empty lines between.
|
||||
type CommentGroup struct { |
||||
List []*Comment // len(List) > 0
|
||||
} |
||||
|
||||
func (c *CommentGroup) Pos() token.Pos { |
||||
return c.List[0].Pos() |
||||
} |
||||
|
||||
//-------------------------------------------------------------------
|
||||
// GoStringer
|
||||
//-------------------------------------------------------------------
|
||||
|
||||
func (o *ObjectKey) GoString() string { return fmt.Sprintf("*%#v", *o) } |
||||
func (o *ObjectList) GoString() string { return fmt.Sprintf("*%#v", *o) } |
||||
@ -0,0 +1,52 @@ |
||||
package ast |
||||
|
||||
import "fmt" |
||||
|
||||
// WalkFunc describes a function to be called for each node during a Walk. The
|
||||
// returned node can be used to rewrite the AST. Walking stops the returned
|
||||
// bool is false.
|
||||
type WalkFunc func(Node) (Node, bool) |
||||
|
||||
// Walk traverses an AST in depth-first order: It starts by calling fn(node);
|
||||
// node must not be nil. If fn returns true, Walk invokes fn recursively for
|
||||
// each of the non-nil children of node, followed by a call of fn(nil). The
|
||||
// returned node of fn can be used to rewrite the passed node to fn.
|
||||
func Walk(node Node, fn WalkFunc) Node { |
||||
rewritten, ok := fn(node) |
||||
if !ok { |
||||
return rewritten |
||||
} |
||||
|
||||
switch n := node.(type) { |
||||
case *File: |
||||
n.Node = Walk(n.Node, fn) |
||||
case *ObjectList: |
||||
for i, item := range n.Items { |
||||
n.Items[i] = Walk(item, fn).(*ObjectItem) |
||||
} |
||||
case *ObjectKey: |
||||
// nothing to do
|
||||
case *ObjectItem: |
||||
for i, k := range n.Keys { |
||||
n.Keys[i] = Walk(k, fn).(*ObjectKey) |
||||
} |
||||
|
||||
if n.Val != nil { |
||||
n.Val = Walk(n.Val, fn) |
||||
} |
||||
case *LiteralType: |
||||
// nothing to do
|
||||
case *ListType: |
||||
for i, l := range n.List { |
||||
n.List[i] = Walk(l, fn) |
||||
} |
||||
case *ObjectType: |
||||
n.List = Walk(n.List, fn).(*ObjectList) |
||||
default: |
||||
// should we panic here?
|
||||
fmt.Printf("unknown type: %T\n", n) |
||||
} |
||||
|
||||
fn(nil) |
||||
return rewritten |
||||
} |
||||
@ -0,0 +1,162 @@ |
||||
// Derivative work from:
|
||||
// - https://golang.org/src/cmd/gofmt/gofmt.go
|
||||
// - https://github.com/fatih/hclfmt
|
||||
|
||||
package fmtcmd |
||||
|
||||
import ( |
||||
"bytes" |
||||
"errors" |
||||
"fmt" |
||||
"io" |
||||
"io/ioutil" |
||||
"os" |
||||
"os/exec" |
||||
"path/filepath" |
||||
"strings" |
||||
|
||||
"github.com/hashicorp/hcl/hcl/printer" |
||||
) |
||||
|
||||
var ( |
||||
ErrWriteStdin = errors.New("cannot use write option with standard input") |
||||
) |
||||
|
||||
type Options struct { |
||||
List bool // list files whose formatting differs
|
||||
Write bool // write result to (source) file instead of stdout
|
||||
Diff bool // display diffs of formatting changes
|
||||
} |
||||
|
||||
func isValidFile(f os.FileInfo, extensions []string) bool { |
||||
if !f.IsDir() && !strings.HasPrefix(f.Name(), ".") { |
||||
for _, ext := range extensions { |
||||
if strings.HasSuffix(f.Name(), "."+ext) { |
||||
return true |
||||
} |
||||
} |
||||
} |
||||
|
||||
return false |
||||
} |
||||
|
||||
// If in == nil, the source is the contents of the file with the given filename.
|
||||
func processFile(filename string, in io.Reader, out io.Writer, stdin bool, opts Options) error { |
||||
if in == nil { |
||||
f, err := os.Open(filename) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
defer f.Close() |
||||
in = f |
||||
} |
||||
|
||||
src, err := ioutil.ReadAll(in) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
res, err := printer.Format(src) |
||||
if err != nil { |
||||
return fmt.Errorf("In %s: %s", filename, err) |
||||
} |
||||
|
||||
if !bytes.Equal(src, res) { |
||||
// formatting has changed
|
||||
if opts.List { |
||||
fmt.Fprintln(out, filename) |
||||
} |
||||
if opts.Write { |
||||
err = ioutil.WriteFile(filename, res, 0644) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
} |
||||
if opts.Diff { |
||||
data, err := diff(src, res) |
||||
if err != nil { |
||||
return fmt.Errorf("computing diff: %s", err) |
||||
} |
||||
fmt.Fprintf(out, "diff a/%s b/%s\n", filename, filename) |
||||
out.Write(data) |
||||
} |
||||
} |
||||
|
||||
if !opts.List && !opts.Write && !opts.Diff { |
||||
_, err = out.Write(res) |
||||
} |
||||
|
||||
return err |
||||
} |
||||
|
||||
func walkDir(path string, extensions []string, stdout io.Writer, opts Options) error { |
||||
visitFile := func(path string, f os.FileInfo, err error) error { |
||||
if err == nil && isValidFile(f, extensions) { |
||||
err = processFile(path, nil, stdout, false, opts) |
||||
} |
||||
return err |
||||
} |
||||
|
||||
return filepath.Walk(path, visitFile) |
||||
} |
||||
|
||||
func Run( |
||||
paths, extensions []string, |
||||
stdin io.Reader, |
||||
stdout io.Writer, |
||||
opts Options, |
||||
) error { |
||||
if len(paths) == 0 { |
||||
if opts.Write { |
||||
return ErrWriteStdin |
||||
} |
||||
if err := processFile("<standard input>", stdin, stdout, true, opts); err != nil { |
||||
return err |
||||
} |
||||
return nil |
||||
} |
||||
|
||||
for _, path := range paths { |
||||
switch dir, err := os.Stat(path); { |
||||
case err != nil: |
||||
return err |
||||
case dir.IsDir(): |
||||
if err := walkDir(path, extensions, stdout, opts); err != nil { |
||||
return err |
||||
} |
||||
default: |
||||
if err := processFile(path, nil, stdout, false, opts); err != nil { |
||||
return err |
||||
} |
||||
} |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func diff(b1, b2 []byte) (data []byte, err error) { |
||||
f1, err := ioutil.TempFile("", "") |
||||
if err != nil { |
||||
return |
||||
} |
||||
defer os.Remove(f1.Name()) |
||||
defer f1.Close() |
||||
|
||||
f2, err := ioutil.TempFile("", "") |
||||
if err != nil { |
||||
return |
||||
} |
||||
defer os.Remove(f2.Name()) |
||||
defer f2.Close() |
||||
|
||||
f1.Write(b1) |
||||
f2.Write(b2) |
||||
|
||||
data, err = exec.Command("diff", "-u", f1.Name(), f2.Name()).CombinedOutput() |
||||
if len(data) > 0 { |
||||
// diff exits with a non-zero status when the files don't match.
|
||||
// Ignore that failure as long as we get output.
|
||||
err = nil |
||||
} |
||||
return |
||||
} |
||||
@ -0,0 +1 @@ |
||||
invalid |
||||
@ -0,0 +1,17 @@ |
||||
package parser |
||||
|
||||
import ( |
||||
"fmt" |
||||
|
||||
"github.com/hashicorp/hcl/hcl/token" |
||||
) |
||||
|
||||
// PosError is a parse error that contains a position.
|
||||
type PosError struct { |
||||
Pos token.Pos |
||||
Err error |
||||
} |
||||
|
||||
func (e *PosError) Error() string { |
||||
return fmt.Sprintf("At %s: %s", e.Pos, e.Err) |
||||
} |
||||
@ -0,0 +1,532 @@ |
||||
// Package parser implements a parser for HCL (HashiCorp Configuration
|
||||
// Language)
|
||||
package parser |
||||
|
||||
import ( |
||||
"bytes" |
||||
"errors" |
||||
"fmt" |
||||
"strings" |
||||
|
||||
"github.com/hashicorp/hcl/hcl/ast" |
||||
"github.com/hashicorp/hcl/hcl/scanner" |
||||
"github.com/hashicorp/hcl/hcl/token" |
||||
) |
||||
|
||||
type Parser struct { |
||||
sc *scanner.Scanner |
||||
|
||||
// Last read token
|
||||
tok token.Token |
||||
commaPrev token.Token |
||||
|
||||
comments []*ast.CommentGroup |
||||
leadComment *ast.CommentGroup // last lead comment
|
||||
lineComment *ast.CommentGroup // last line comment
|
||||
|
||||
enableTrace bool |
||||
indent int |
||||
n int // buffer size (max = 1)
|
||||
} |
||||
|
||||
func newParser(src []byte) *Parser { |
||||
return &Parser{ |
||||
sc: scanner.New(src), |
||||
} |
||||
} |
||||
|
||||
// Parse returns the fully parsed source and returns the abstract syntax tree.
|
||||
func Parse(src []byte) (*ast.File, error) { |
||||
// normalize all line endings
|
||||
// since the scanner and output only work with "\n" line endings, we may
|
||||
// end up with dangling "\r" characters in the parsed data.
|
||||
src = bytes.Replace(src, []byte("\r\n"), []byte("\n"), -1) |
||||
|
||||
p := newParser(src) |
||||
return p.Parse() |
||||
} |
||||
|
||||
var errEofToken = errors.New("EOF token found") |
||||
|
||||
// Parse returns the fully parsed source and returns the abstract syntax tree.
|
||||
func (p *Parser) Parse() (*ast.File, error) { |
||||
f := &ast.File{} |
||||
var err, scerr error |
||||
p.sc.Error = func(pos token.Pos, msg string) { |
||||
scerr = &PosError{Pos: pos, Err: errors.New(msg)} |
||||
} |
||||
|
||||
f.Node, err = p.objectList(false) |
||||
if scerr != nil { |
||||
return nil, scerr |
||||
} |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
f.Comments = p.comments |
||||
return f, nil |
||||
} |
||||
|
||||
// objectList parses a list of items within an object (generally k/v pairs).
|
||||
// The parameter" obj" tells this whether to we are within an object (braces:
|
||||
// '{', '}') or just at the top level. If we're within an object, we end
|
||||
// at an RBRACE.
|
||||
func (p *Parser) objectList(obj bool) (*ast.ObjectList, error) { |
||||
defer un(trace(p, "ParseObjectList")) |
||||
node := &ast.ObjectList{} |
||||
|
||||
for { |
||||
if obj { |
||||
tok := p.scan() |
||||
p.unscan() |
||||
if tok.Type == token.RBRACE { |
||||
break |
||||
} |
||||
} |
||||
|
||||
n, err := p.objectItem() |
||||
if err == errEofToken { |
||||
break // we are finished
|
||||
} |
||||
|
||||
// we don't return a nil node, because might want to use already
|
||||
// collected items.
|
||||
if err != nil { |
||||
return node, err |
||||
} |
||||
|
||||
node.Add(n) |
||||
|
||||
// object lists can be optionally comma-delimited e.g. when a list of maps
|
||||
// is being expressed, so a comma is allowed here - it's simply consumed
|
||||
tok := p.scan() |
||||
if tok.Type != token.COMMA { |
||||
p.unscan() |
||||
} |
||||
} |
||||
return node, nil |
||||
} |
||||
|
||||
func (p *Parser) consumeComment() (comment *ast.Comment, endline int) { |
||||
endline = p.tok.Pos.Line |
||||
|
||||
// count the endline if it's multiline comment, ie starting with /*
|
||||
if len(p.tok.Text) > 1 && p.tok.Text[1] == '*' { |
||||
// don't use range here - no need to decode Unicode code points
|
||||
for i := 0; i < len(p.tok.Text); i++ { |
||||
if p.tok.Text[i] == '\n' { |
||||
endline++ |
||||
} |
||||
} |
||||
} |
||||
|
||||
comment = &ast.Comment{Start: p.tok.Pos, Text: p.tok.Text} |
||||
p.tok = p.sc.Scan() |
||||
return |
||||
} |
||||
|
||||
func (p *Parser) consumeCommentGroup(n int) (comments *ast.CommentGroup, endline int) { |
||||
var list []*ast.Comment |
||||
endline = p.tok.Pos.Line |
||||
|
||||
for p.tok.Type == token.COMMENT && p.tok.Pos.Line <= endline+n { |
||||
var comment *ast.Comment |
||||
comment, endline = p.consumeComment() |
||||
list = append(list, comment) |
||||
} |
||||
|
||||
// add comment group to the comments list
|
||||
comments = &ast.CommentGroup{List: list} |
||||
p.comments = append(p.comments, comments) |
||||
|
||||
return |
||||
} |
||||
|
||||
// objectItem parses a single object item
|
||||
func (p *Parser) objectItem() (*ast.ObjectItem, error) { |
||||
defer un(trace(p, "ParseObjectItem")) |
||||
|
||||
keys, err := p.objectKey() |
||||
if len(keys) > 0 && err == errEofToken { |
||||
// We ignore eof token here since it is an error if we didn't
|
||||
// receive a value (but we did receive a key) for the item.
|
||||
err = nil |
||||
} |
||||
if len(keys) > 0 && err != nil && p.tok.Type == token.RBRACE { |
||||
// This is a strange boolean statement, but what it means is:
|
||||
// We have keys with no value, and we're likely in an object
|
||||
// (since RBrace ends an object). For this, we set err to nil so
|
||||
// we continue and get the error below of having the wrong value
|
||||
// type.
|
||||
err = nil |
||||
|
||||
// Reset the token type so we don't think it completed fine. See
|
||||
// objectType which uses p.tok.Type to check if we're done with
|
||||
// the object.
|
||||
p.tok.Type = token.EOF |
||||
} |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
o := &ast.ObjectItem{ |
||||
Keys: keys, |
||||
} |
||||
|
||||
if p.leadComment != nil { |
||||
o.LeadComment = p.leadComment |
||||
p.leadComment = nil |
||||
} |
||||
|
||||
switch p.tok.Type { |
||||
case token.ASSIGN: |
||||
o.Assign = p.tok.Pos |
||||
o.Val, err = p.object() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
case token.LBRACE: |
||||
o.Val, err = p.objectType() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
default: |
||||
keyStr := make([]string, 0, len(keys)) |
||||
for _, k := range keys { |
||||
keyStr = append(keyStr, k.Token.Text) |
||||
} |
||||
|
||||
return nil, &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: fmt.Errorf( |
||||
"key '%s' expected start of object ('{') or assignment ('=')", |
||||
strings.Join(keyStr, " ")), |
||||
} |
||||
} |
||||
|
||||
// key=#comment
|
||||
// val
|
||||
if p.lineComment != nil { |
||||
o.LineComment, p.lineComment = p.lineComment, nil |
||||
} |
||||
|
||||
// do a look-ahead for line comment
|
||||
p.scan() |
||||
if len(keys) > 0 && o.Val.Pos().Line == keys[0].Pos().Line && p.lineComment != nil { |
||||
o.LineComment = p.lineComment |
||||
p.lineComment = nil |
||||
} |
||||
p.unscan() |
||||
return o, nil |
||||
} |
||||
|
||||
// objectKey parses an object key and returns a ObjectKey AST
|
||||
func (p *Parser) objectKey() ([]*ast.ObjectKey, error) { |
||||
keyCount := 0 |
||||
keys := make([]*ast.ObjectKey, 0) |
||||
|
||||
for { |
||||
tok := p.scan() |
||||
switch tok.Type { |
||||
case token.EOF: |
||||
// It is very important to also return the keys here as well as
|
||||
// the error. This is because we need to be able to tell if we
|
||||
// did parse keys prior to finding the EOF, or if we just found
|
||||
// a bare EOF.
|
||||
return keys, errEofToken |
||||
case token.ASSIGN: |
||||
// assignment or object only, but not nested objects. this is not
|
||||
// allowed: `foo bar = {}`
|
||||
if keyCount > 1 { |
||||
return nil, &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: fmt.Errorf("nested object expected: LBRACE got: %s", p.tok.Type), |
||||
} |
||||
} |
||||
|
||||
if keyCount == 0 { |
||||
return nil, &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: errors.New("no object keys found!"), |
||||
} |
||||
} |
||||
|
||||
return keys, nil |
||||
case token.LBRACE: |
||||
var err error |
||||
|
||||
// If we have no keys, then it is a syntax error. i.e. {{}} is not
|
||||
// allowed.
|
||||
if len(keys) == 0 { |
||||
err = &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: fmt.Errorf("expected: IDENT | STRING got: %s", p.tok.Type), |
||||
} |
||||
} |
||||
|
||||
// object
|
||||
return keys, err |
||||
case token.IDENT, token.STRING: |
||||
keyCount++ |
||||
keys = append(keys, &ast.ObjectKey{Token: p.tok}) |
||||
case token.ILLEGAL: |
||||
return keys, &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: fmt.Errorf("illegal character"), |
||||
} |
||||
default: |
||||
return keys, &PosError{ |
||||
Pos: p.tok.Pos, |
||||
Err: fmt.Errorf("expected: IDENT | STRING | ASSIGN | LBRACE got: %s", p.tok.Type), |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
// object parses any type of object, such as number, bool, string, object or
|
||||
// list.
|
||||
func (p *Parser) object() (ast.Node, error) { |
||||
defer un(trace(p, "ParseType")) |
||||
tok := p.scan() |
||||
|
||||
switch tok.Type { |
||||
case token.NUMBER, token.FLOAT, token.BOOL, token.STRING, token.HEREDOC: |
||||
return p.literalType() |
||||
case token.LBRACE: |
||||
return p.objectType() |
||||
case token.LBRACK: |
||||
return p.listType() |
||||
case token.COMMENT: |
||||
// implement comment
|
||||
case token.EOF: |
||||
return nil, errEofToken |
||||
} |
||||
|
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf("Unknown token: %+v", tok), |
||||
} |
||||
} |
||||
|
||||
// objectType parses an object type and returns a ObjectType AST
|
||||
func (p *Parser) objectType() (*ast.ObjectType, error) { |
||||
defer un(trace(p, "ParseObjectType")) |
||||
|
||||
// we assume that the currently scanned token is a LBRACE
|
||||
o := &ast.ObjectType{ |
||||
Lbrace: p.tok.Pos, |
||||
} |
||||
|
||||
l, err := p.objectList(true) |
||||
|
||||
// if we hit RBRACE, we are good to go (means we parsed all Items), if it's
|
||||
// not a RBRACE, it's an syntax error and we just return it.
|
||||
if err != nil && p.tok.Type != token.RBRACE { |
||||
return nil, err |
||||
} |
||||
|
||||
// No error, scan and expect the ending to be a brace
|
||||
if tok := p.scan(); tok.Type != token.RBRACE { |
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf("object expected closing RBRACE got: %s", tok.Type), |
||||
} |
||||
} |
||||
|
||||
o.List = l |
||||
o.Rbrace = p.tok.Pos // advanced via parseObjectList
|
||||
return o, nil |
||||
} |
||||
|
||||
// listType parses a list type and returns a ListType AST
|
||||
func (p *Parser) listType() (*ast.ListType, error) { |
||||
defer un(trace(p, "ParseListType")) |
||||
|
||||
// we assume that the currently scanned token is a LBRACK
|
||||
l := &ast.ListType{ |
||||
Lbrack: p.tok.Pos, |
||||
} |
||||
|
||||
needComma := false |
||||
for { |
||||
tok := p.scan() |
||||
if needComma { |
||||
switch tok.Type { |
||||
case token.COMMA, token.RBRACK: |
||||
default: |
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf( |
||||
"error parsing list, expected comma or list end, got: %s", |
||||
tok.Type), |
||||
} |
||||
} |
||||
} |
||||
switch tok.Type { |
||||
case token.BOOL, token.NUMBER, token.FLOAT, token.STRING, token.HEREDOC: |
||||
node, err := p.literalType() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
// If there is a lead comment, apply it
|
||||
if p.leadComment != nil { |
||||
node.LeadComment = p.leadComment |
||||
p.leadComment = nil |
||||
} |
||||
|
||||
l.Add(node) |
||||
needComma = true |
||||
case token.COMMA: |
||||
// get next list item or we are at the end
|
||||
// do a look-ahead for line comment
|
||||
p.scan() |
||||
if p.lineComment != nil && len(l.List) > 0 { |
||||
lit, ok := l.List[len(l.List)-1].(*ast.LiteralType) |
||||
if ok { |
||||
lit.LineComment = p.lineComment |
||||
l.List[len(l.List)-1] = lit |
||||
p.lineComment = nil |
||||
} |
||||
} |
||||
p.unscan() |
||||
|
||||
needComma = false |
||||
continue |
||||
case token.LBRACE: |
||||
// Looks like a nested object, so parse it out
|
||||
node, err := p.objectType() |
||||
if err != nil { |
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf( |
||||
"error while trying to parse object within list: %s", err), |
||||
} |
||||
} |
||||
l.Add(node) |
||||
needComma = true |
||||
case token.LBRACK: |
||||
node, err := p.listType() |
||||
if err != nil { |
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf( |
||||
"error while trying to parse list within list: %s", err), |
||||
} |
||||
} |
||||
l.Add(node) |
||||
case token.RBRACK: |
||||
// finished
|
||||
l.Rbrack = p.tok.Pos |
||||
return l, nil |
||||
default: |
||||
return nil, &PosError{ |
||||
Pos: tok.Pos, |
||||
Err: fmt.Errorf("unexpected token while parsing list: %s", tok.Type), |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
// literalType parses a literal type and returns a LiteralType AST
|
||||
func (p *Parser) literalType() (*ast.LiteralType, error) { |
||||
defer un(trace(p, "ParseLiteral")) |
||||
|
||||
return &ast.LiteralType{ |
||||
Token: p.tok, |
||||
}, nil |
||||
} |
||||
|
||||
// scan returns the next token from the underlying scanner. If a token has
|
||||
// been unscanned then read that instead. In the process, it collects any
|
||||
// comment groups encountered, and remembers the last lead and line comments.
|
||||
func (p *Parser) scan() token.Token { |
||||
// If we have a token on the buffer, then return it.
|
||||
if p.n != 0 { |
||||
p.n = 0 |
||||
return p.tok |
||||
} |
||||
|
||||
// Otherwise read the next token from the scanner and Save it to the buffer
|
||||
// in case we unscan later.
|
||||
prev := p.tok |
||||
p.tok = p.sc.Scan() |
||||
|
||||
if p.tok.Type == token.COMMENT { |
||||
var comment *ast.CommentGroup |
||||
var endline int |
||||
|
||||
// fmt.Printf("p.tok.Pos.Line = %+v prev: %d endline %d \n",
|
||||
// p.tok.Pos.Line, prev.Pos.Line, endline)
|
||||
if p.tok.Pos.Line == prev.Pos.Line { |
||||
// The comment is on same line as the previous token; it
|
||||
// cannot be a lead comment but may be a line comment.
|
||||
comment, endline = p.consumeCommentGroup(0) |
||||
if p.tok.Pos.Line != endline { |
||||
// The next token is on a different line, thus
|
||||
// the last comment group is a line comment.
|
||||
p.lineComment = comment |
||||
} |
||||
} |
||||
|
||||
// consume successor comments, if any
|
||||
endline = -1 |
||||
for p.tok.Type == token.COMMENT { |
||||
comment, endline = p.consumeCommentGroup(1) |
||||
} |
||||
|
||||
if endline+1 == p.tok.Pos.Line && p.tok.Type != token.RBRACE { |
||||
switch p.tok.Type { |
||||
case token.RBRACE, token.RBRACK: |
||||
// Do not count for these cases
|
||||
default: |
||||
// The next token is following on the line immediately after the
|
||||
// comment group, thus the last comment group is a lead comment.
|
||||
p.leadComment = comment |
||||
} |
||||
} |
||||
|
||||
} |
||||
|
||||
return p.tok |
||||
} |
||||
|
||||
// unscan pushes the previously read token back onto the buffer.
|
||||
func (p *Parser) unscan() { |
||||
p.n = 1 |
||||
} |
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// Parsing support
|
||||
|
||||
func (p *Parser) printTrace(a ...interface{}) { |
||||
if !p.enableTrace { |
||||
return |
||||
} |
||||
|
||||
const dots = ". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . " |
||||
const n = len(dots) |
||||
fmt.Printf("%5d:%3d: ", p.tok.Pos.Line, p.tok.Pos.Column) |
||||
|
||||
i := 2 * p.indent |
||||
for i > n { |
||||
fmt.Print(dots) |
||||
i -= n |
||||
} |
||||
// i <= n
|
||||
fmt.Print(dots[0:i]) |
||||
fmt.Println(a...) |
||||
} |
||||
|
||||
func trace(p *Parser, msg string) *Parser { |
||||
p.printTrace(msg, "(") |
||||
p.indent++ |
||||
return p |
||||
} |
||||
|
||||
// Usage pattern: defer un(trace(p, "..."))
|
||||
func un(p *Parser) { |
||||
p.indent-- |
||||
p.printTrace(")") |
||||
} |
||||
@ -0,0 +1,4 @@ |
||||
foo = [ |
||||
"1", |
||||
"2", # comment |
||||
] |
||||
@ -0,0 +1,6 @@ |
||||
provisioner "remote-exec" { |
||||
scripts = [ |
||||
"${path.module}/scripts/install-consul.sh" // missing comma |
||||
"${path.module}/scripts/install-haproxy.sh" |
||||
] |
||||
} |
||||
@ -0,0 +1,6 @@ |
||||
resource = [{ |
||||
"foo": { |
||||
"bar": {}, |
||||
"baz": [1, 2, "foo"], |
||||
} |
||||
}] |
||||
@ -0,0 +1,5 @@ |
||||
resource = [{ |
||||
foo = [{ |
||||
bar = {} |
||||
}] |
||||
}] |
||||
@ -0,0 +1,15 @@ |
||||
// Foo |
||||
|
||||
/* Bar */ |
||||
|
||||
/* |
||||
/* |
||||
Baz |
||||
*/ |
||||
|
||||
# Another |
||||
|
||||
# Multiple |
||||
# Lines |
||||
|
||||
foo = "bar" |
||||
@ -0,0 +1,15 @@ |
||||
// Foo |
||||
|
||||
/* Bar */ |
||||
|
||||
/* |
||||
/* |
||||
Baz |
||||
*/ |
||||
|
||||
# Another |
||||
|
||||
# Multiple |
||||
# Lines |
||||
|
||||
foo = "bar" |
||||
@ -0,0 +1 @@ |
||||
#foo |
||||
@ -0,0 +1 @@ |
||||
# Hello |
||||
@ -0,0 +1,42 @@ |
||||
variable "foo" { |
||||
default = "bar" |
||||
description = "bar" |
||||
} |
||||
|
||||
variable "groups" { } |
||||
|
||||
provider "aws" { |
||||
access_key = "foo" |
||||
secret_key = "bar" |
||||
} |
||||
|
||||
provider "do" { |
||||
api_key = "${var.foo}" |
||||
} |
||||
|
||||
resource "aws_security_group" "firewall" { |
||||
count = 5 |
||||
} |
||||
|
||||
resource aws_instance "web" { |
||||
ami = "${var.foo}" |
||||
security_groups = [ |
||||
"foo", |
||||
"${aws_security_group.firewall.foo}", |
||||
"${element(split(\",\", var.groups)}", |
||||
] |
||||
network_interface = { |
||||
device_index = 0 |
||||
description = "Main network interface" |
||||
} |
||||
} |
||||
|
||||
resource "aws_instance" "db" { |
||||
security_groups = "${aws_security_group.firewall.*.id}" |
||||
VPC = "foo" |
||||
depends_on = ["aws_instance.web"] |
||||
} |
||||
|
||||
output "web_ip" { |
||||
value = "${aws_instance.web.private_ip}" |
||||
} |
||||
@ -0,0 +1,42 @@ |
||||
variable "foo" { |
||||
default = "bar" |
||||
description = "bar" |
||||
} |
||||
|
||||
variable "groups" { } |
||||
|
||||
provider "aws" { |
||||
access_key = "foo" |
||||
secret_key = "bar" |
||||
} |
||||
|
||||
provider "do" { |
||||
api_key = "${var.foo}" |
||||
} |
||||
|
||||
resource "aws_security_group" "firewall" { |
||||
count = 5 |
||||
} |
||||
|
||||
resource aws_instance "web" { |
||||
ami = "${var.foo}" |
||||
security_groups = [ |
||||
"foo", |
||||
"${aws_security_group.firewall.foo}", |
||||
"${element(split(\",\", var.groups)}", |
||||
] |
||||
network_interface = { |
||||
device_index = 0 |
||||
description = "Main network interface" |
||||
} |
||||
} |
||||
|
||||
resource "aws_instance" "db" { |
||||
security_groups = "${aws_security_group.firewall.*.id}" |
||||
VPC = "foo" |
||||
depends_on = ["aws_instance.web"] |
||||
} |
||||
|
||||
output "web_ip" { |
||||
value = "${aws_instance.web.private_ip}" |
||||
} |
||||
@ -0,0 +1 @@ |
||||
foo.bar = "baz" |
||||
Binary file not shown.
@ -0,0 +1 @@ |
||||
foo |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue