├── .gitignore ├── .goreleaser.yml ├── Gopkg.lock ├── Gopkg.toml ├── LICENSE ├── Makefile ├── README.md └── main.go /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | ksd 3 | -------------------------------------------------------------------------------- /.goreleaser.yml: -------------------------------------------------------------------------------- 1 | # This is an example goreleaser.yaml file with some sane defaults. 2 | # Make sure to check the documentation at http://goreleaser.com 3 | builds: 4 | - 5 | env: 6 | - CGO_ENABLED=0 7 | main: ./main.go 8 | binary: kubectl-ksd 9 | archive: 10 | replacements: 11 | darwin: Darwin 12 | linux: Linux 13 | windows: Windows 14 | 386: i386 15 | amd64: x86_64 16 | snapshot: 17 | name_template: "{{ .Tag }}-next" 18 | changelog: 19 | sort: asc 20 | filters: 21 | exclude: 22 | - '^docs:' 23 | - '^test:' 24 | release: 25 | -------------------------------------------------------------------------------- /Gopkg.lock: -------------------------------------------------------------------------------- 1 | # This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'. 2 | 3 | 4 | [[projects]] 5 | digest = "1:342378ac4dcb378a5448dd723f0784ae519383532f5e70ade24132c4c8693202" 6 | name = "gopkg.in/yaml.v2" 7 | packages = ["."] 8 | pruneopts = "UT" 9 | revision = "5420a8b6744d3b0345ab293f6fcba19c978f1183" 10 | version = "v2.2.1" 11 | 12 | [solve-meta] 13 | analyzer-name = "dep" 14 | analyzer-version = 1 15 | input-imports = ["gopkg.in/yaml.v2"] 16 | solver-name = "gps-cdcl" 17 | solver-version = 1 18 | -------------------------------------------------------------------------------- /Gopkg.toml: -------------------------------------------------------------------------------- 1 | [[constraint]] 2 | name = "gopkg.in/yaml.v2" 3 | version = "2.2.1" 4 | 5 | [prune] 6 | go-tests = true 7 | unused-packages = true 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL=/bin/bash 2 | BINARY_NAME:="kubectl-ksd" 3 | GOPATH:="${HOME}/go" 4 | 5 | .PHONY: install 6 | install: ## Install the binary 7 | @go build -o ${GOPATH}/bin/${BINARY_NAME} 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kubernetes Secret Decode 2 | 3 | ### Description 4 | Be able to easily see the values of a secret. 5 | 6 | YAML and JSON are both supported and detection of the input type is performed automatically. 7 | 8 | **Before:** 9 | ```yaml 10 | $ kubectl get secret my-secret -o yaml 11 | apiVersion: v1 12 | data: 13 | password: cGFzc3dvcmQ= 14 | username: dXNlcm5hbWU= 15 | kind: Secret 16 | metadata: 17 | creationTimestamp: 2018-05-09T21:01:37Z 18 | name: my-secret 19 | namespace: default 20 | resourceVersion: "20229" 21 | selfLink: /api/v1/namespaces/default/secrets/my-secret 22 | uid: 29ef8024-53cc-11e8-967d-080027cd91ae 23 | type: Opaque 24 | ``` 25 | 26 | **After:** 27 | ```yaml 28 | $ kubectl ksd get secret my-secret -o yaml 29 | apiVersion: v1 30 | stringData: 31 | password: password 32 | username: username 33 | kind: Secret 34 | metadata: 35 | creationTimestamp: "2018-05-09T21:01:37Z" 36 | name: my-secret 37 | namespace: default 38 | resourceVersion: "20229" 39 | selfLink: /api/v1/namespaces/default/secrets/my-secret 40 | uid: 29ef8024-53cc-11e8-967d-080027cd91ae 41 | type: Opaque 42 | ``` 43 | 44 | ### Installation 45 | #### Prebuilt 46 | Download the appropriate binary for your OS from the [releases section](https://github.com/ashleyschuett/kubernetes-secret-decode/releases), make it executable and add it to your path. 47 | 48 | #### Compile From Source 49 | These instructions assume you have go installed and a `$GOPATH` set. 50 | The binary needs to be installed somewhere in your `$PATH`. 51 | The binary also needs to be named either `kubectl-ksd` or `kubectl-kubernetes-secret-decode` 52 | 53 | For easy install running the following: 54 | ``` 55 | make install 56 | ``` 57 | 58 | ### Usage 59 | `kubectl ksd get secret my-secret -o yaml` 60 | 61 | `kubectl ksd get secret my-secret -o json` 62 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "bytes" 6 | b64 "encoding/base64" 7 | "encoding/json" 8 | "fmt" 9 | "io" 10 | "os" 11 | "os/exec" 12 | "strings" 13 | 14 | yaml "gopkg.in/yaml.v2" 15 | ) 16 | 17 | const ( 18 | // dataKey is the name of the key that is populated with the Kubernetes 19 | // secret's data 20 | dataKey = "data" 21 | // stringDataKey is the name of the key that is used writing a secret's plain 22 | // text information to save to the secret. On save Kubernetes encodes this field 23 | stringDataKey = "stringData" 24 | ) 25 | 26 | var outputType string 27 | 28 | // SecretData extracts out the data portion of a Kubernetes secret 29 | type SecretData struct { 30 | Data map[string]string `json:"data" yaml:"data"` 31 | } 32 | 33 | // Secret allows us to read and return the full Kubernetes secret 34 | type Secret map[string]interface{} 35 | 36 | // Unmarshallable allows me to unmarsal different strings with the same interface 37 | type Unmarshallable func([]byte, interface{}) error 38 | 39 | func main() { 40 | // parse the rest of the command to kubectl and run it 41 | output := parseAndRunCommand() 42 | unmarshal := getUnmarshalByOutputType(outputType) 43 | 44 | sd, err := getDecodedSecretData(unmarshal, output.Bytes()) 45 | if err != nil { 46 | fmt.Fprint(os.Stderr, err) 47 | os.Exit(1) 48 | } 49 | 50 | s, err := getFullSecretWithDecodedData(unmarshal, output.Bytes(), sd) 51 | if err != nil { 52 | fmt.Fprint(os.Stderr, err) 53 | os.Exit(1) 54 | } 55 | 56 | secret := getStringSecret(s, outputType) 57 | // Print exposed secret 58 | fmt.Fprintf(os.Stdout, "%s\n", secret) 59 | } 60 | 61 | func parseAndRunCommand() bytes.Buffer { 62 | args := getKubectlArgs() 63 | 64 | // check that the global output type was set, if it's not set we can not decode the secret 65 | if outputType == "" { 66 | fmt.Fprintf(os.Stdout, "please set -o flag to json or yaml\n") 67 | os.Exit(1) 68 | } 69 | 70 | cmd := exec.Command("kubectl", args...) 71 | 72 | var output, errb bytes.Buffer 73 | cmd.Stdout = &output 74 | cmd.Stderr = &errb 75 | 76 | if err := cmd.Run(); err != nil { 77 | fmt.Fprintf(os.Stdout, errb.String()) 78 | os.Exit(1) 79 | } 80 | 81 | return output 82 | } 83 | 84 | func getKubectlArgs() []string { 85 | var args []string 86 | 87 | for i, arg := range os.Args { 88 | // remove the ksd binary from the kubectl command 89 | if strings.Contains(arg, "kubectl-ksd") || strings.Contains(arg, "kubernetes-secret-decode") { 90 | args = append(os.Args[:i], os.Args[i+1:]...) 91 | } 92 | 93 | if strings.Contains(arg, "json") || strings.Contains(arg, "yaml") { 94 | // this set the global variable that is used for parsing the output 95 | outputType = strings.Trim(arg, "-o") 96 | } 97 | } 98 | 99 | return args 100 | } 101 | 102 | func getUnmarshalByOutputType(outputType string) Unmarshallable { 103 | var unmarshal Unmarshallable 104 | if isJSON(outputType) { 105 | unmarshal = json.Unmarshal 106 | } else { 107 | unmarshal = yaml.Unmarshal 108 | } 109 | 110 | return unmarshal 111 | } 112 | 113 | func getStringSecret(s *Secret, outputType string) string { 114 | var secret []byte 115 | if isJSON(outputType) { 116 | secret, _ = json.MarshalIndent(s, "", " ") 117 | } else { 118 | secret, _ = yaml.Marshal(s) 119 | } 120 | 121 | return string(secret) 122 | } 123 | 124 | func getFullSecretWithDecodedData(unmarshal Unmarshallable, output []byte, sd *SecretData) (*Secret, error) { 125 | var s Secret 126 | var err error 127 | 128 | err = unmarshal(output, &s) 129 | if err != nil { 130 | return nil, err 131 | } 132 | 133 | for key := range s { 134 | if key == dataKey { 135 | s[stringDataKey] = sd.Data 136 | } 137 | } 138 | 139 | delete(s, dataKey) 140 | 141 | return &s, nil 142 | } 143 | 144 | func getDecodedSecretData(unmarshal Unmarshallable, output []byte) (*SecretData, error) { 145 | var s SecretData 146 | var err error 147 | 148 | err = unmarshal(output, &s) 149 | if err != nil { 150 | return nil, err 151 | } 152 | 153 | err = parseData(&s) 154 | if err != nil { 155 | return nil, err 156 | } 157 | 158 | return &s, nil 159 | } 160 | 161 | func getKubectlSecretOutput() []byte { 162 | var output []byte 163 | reader := bufio.NewReader(os.Stdout) 164 | 165 | for { 166 | input, err := reader.ReadByte() 167 | if err != nil && err == io.EOF { 168 | break 169 | } 170 | 171 | output = append(output, input) 172 | } 173 | 174 | return output 175 | } 176 | 177 | func isJSON(o string) bool { 178 | return o == "json" 179 | } 180 | 181 | func parseData(s *SecretData) error { 182 | var err error 183 | for key, value := range s.Data { 184 | s.Data[key], err = decodeString(value) 185 | if err != nil { 186 | return err 187 | } 188 | } 189 | 190 | return nil 191 | } 192 | 193 | func decodeString(encoded string) (string, error) { 194 | decoded, err := b64.StdEncoding.DecodeString(encoded) 195 | if err != nil { 196 | return "", err 197 | } 198 | 199 | return string(decoded), nil 200 | } 201 | --------------------------------------------------------------------------------