├── .github
└── workflows
│ ├── bump-version.yml
│ └── main.yml
├── LICENSE
├── README.md
├── action.yml
└── env-export
├── Dockerfile
├── action.yml
├── app-info.sh
└── entrypoint.sh
/.github/workflows/bump-version.yml:
--------------------------------------------------------------------------------
1 | on:
2 | push:
3 | branches:
4 | - release/v*
5 |
6 | jobs:
7 | bump-version:
8 | name: Bump app info version
9 | runs-on: ubuntu-latest
10 | steps:
11 | - name: Load secrets
12 | uses: secrethub/actions/env-export@v0.1.0
13 | env:
14 | SECRETHUB_CREDENTIAL: ${{ secrets.SECRETHUB_CREDENTIAL }}
15 | GITHUB_TOKEN: secrethub://secrethub/github-actions/github/token
16 | - name: Checkout
17 | uses: actions/checkout@v2
18 | with:
19 | token: ${{ env.GITHUB_TOKEN }}
20 | - name: Bump version
21 | uses: florisvdg/action-version-bump@v0.1.0
22 | with:
23 | sed: 's/\(export SECRETHUB_APP_INFO_VERSION=\).*/\1$VERSION/g'
24 | file: env-export/app-info.sh
25 | author_email: bender.github@secrethub.io
26 |
--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
1 | on: push
2 | jobs:
3 | test:
4 | runs-on: ubuntu-latest
5 | steps:
6 | - uses: actions/checkout@v2
7 | - uses: ./env-export
8 | env:
9 | SECRETHUB_CREDENTIAL: ${{ secrets.SECRETHUB_CREDENTIAL }}
10 | SECRET: secrethub://secrethub/github-actions/tst/secret
11 | MULTILINE_SECRET: secrethub://secrethub/github-actions/tst/multiline_secret
12 | - name: Print environment with masked secrets
13 | run: printenv
14 | - name: Test secret is set to correct value
15 | run: if [ "$SECRET" != "DDXLKkBhprQgW7w7OFsM8y" ]; then echo "secret is not set as expected" && exit 1; fi
16 | - name: Test multiline secret is set to correct value
17 | env:
18 | MULTILINE_SECRET_EXPECTED: |-
19 | 4dAXbmYWiLkyYpExLnhGRD9wA7
20 | rsrNbNYprQZHz8Vtgu4fJezGDB
21 | run: if [ "$MULTILINE_SECRET" != "$MULTILINE_SECRET_EXPECTED" ]; then echo "secret is not set as expected" && exit 1; fi
22 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
SecretHub has joined 1Password! Find out more on the SecretHub blog. 🎉
4 |
5 |
6 |
7 |
8 | 
9 |
10 |
11 |
12 |
13 | 
14 |
15 |
16 |
17 |
18 | # Actions
19 |
20 | [](https://github.com/secrethub/actions/actions)
21 | [](https://github.com/secrethub/actions/releases/latest)
22 | [](https://discord.gg/NWmxVeb)
23 |
24 | > [SecretHub](https://secrethub.io) is a secrets management tool that works for every engineer. Securely provision passwords and keys throughout your entire stack with just a few lines of code.
25 |
26 | No more copy-pasting sensitive values into a GUI. Securely load secrets into GitHub Actions and sync them automatically using SecretHub.
27 |
28 | This Action is officially supported and actively maintained by SecretHub, but community contributions are very welcome.
29 |
30 | ## secrethub/actions/env-export
31 |
32 | The `env-export` action reads all referenced secrets from environment variables prefixed by `secrethub://` and secrets specified in the `secrethub.env` template file, and makes the secret values available as environment variables to the rest of the job.
33 |
34 | It leverages GitHub's output masking feature, so if secret values are (accidentally) logged, they get replaced with `*****`.
35 |
36 | ### Usage
37 |
38 | ```yml
39 | on: push
40 | jobs:
41 | notify-slack:
42 | runs-on: ubuntu-latest
43 | steps:
44 | - uses: actions/checkout@v2
45 | - uses: secrethub/actions/env-export@v0.2.1
46 | env:
47 | SECRETHUB_CREDENTIAL: ${{ secrets.SECRETHUB_CREDENTIAL }}
48 | SLACK_WEBHOOK: secrethub://company/app/slack/webhook
49 | - name: Print environment with masked secrets
50 | run: printenv
51 | - name: Notify Slack
52 | # This action expects SLACK_WEBHOOK to be set, which is now done automatically
53 | uses: Ilshidur/action-slack@2.0.1
54 | with:
55 | args: Sent from GitHub Actions with secrets from SecretHub 🔑
56 | ```
57 |
58 | ## Credential
59 |
60 | The example above passes the `SECRETHUB_CREDENTIAL` environment variable. This credential is used to authenticate to SecretHub and decrypt your secrets.
61 |
62 | You can obtain a credential by creating a [service account](https://secrethub.io/docs/reference/cli/service). Service accounts are completely separate accounts from your personal account, which means you can [manage their access](https://secrethub.io/docs/reference/cli/acl/) separately and you can identify them in the [audit log](https://secrethub.io/docs/reference/cli/audit/).
63 |
64 | After you've obtained a credential for SecretHub, you [store it in a GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository), so that it can be fetched in your action as shown above.
65 |
--------------------------------------------------------------------------------
/action.yml:
--------------------------------------------------------------------------------
1 | name: SecretHub
2 | description: Load secrets into your GitHub workflows
3 | branding:
4 | icon: lock
5 | color: blue
6 | runs:
7 | using: docker
8 | image: docker://alpine
9 | args:
10 | - echo
11 | - -e
12 | - "Choose one of the available SecretHub Actions:\n * secrethub/actions/env-export"
13 |
--------------------------------------------------------------------------------
/env-export/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM secrethub/cli:0.40.0
2 |
3 | RUN apk add sed
4 |
5 | COPY entrypoint.sh /entrypoint.sh
6 | COPY app-info.sh /app-info.sh
7 |
8 | ENTRYPOINT ["/entrypoint.sh"]
9 |
--------------------------------------------------------------------------------
/env-export/action.yml:
--------------------------------------------------------------------------------
1 | name: SecretHub - Export Environment Variables
2 | description: Make secrets from SecretHub available to your job as environment variables
3 | runs:
4 | using: docker
5 | image: Dockerfile
6 | branding:
7 | icon: lock
8 | color: blue
9 |
--------------------------------------------------------------------------------
/env-export/app-info.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | export SECRETHUB_APP_INFO_NAME=secrethub-action-env-export
4 | # Version is automatically bumped on release branches
5 | export SECRETHUB_APP_INFO_VERSION=0.2.1
6 |
--------------------------------------------------------------------------------
/env-export/entrypoint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | set -e
3 |
4 | source /app-info.sh
5 |
6 | env_var_names=$(secrethub env ls)
7 | echo "The following environment variables will be populated with secrets from SecretHub:"
8 | echo "$env_var_names"
9 |
10 | for var_name in $env_var_names; do
11 | secret_value=$(secrethub env read $var_name)
12 |
13 | # Escape percent signs and add a mask per line (see https://github.com/actions/runner/issues/161)
14 | escaped_mask_value=$(echo "$secret_value" | sed -e 's/%/%25/g')
15 | IFS=$'\n'
16 | for line in $escaped_mask_value; do
17 | echo "::add-mask::$line"
18 | done
19 | unset IFS
20 |
21 | # Use new environment file syntax on runners that support it.
22 | if [ -n "${GITHUB_ENV}" ]; then
23 | # A random 64 character string is used as the heredoc identifier, to make it practically
24 | # impossible that this string appears in the secret.
25 | random_heredoc_identifier=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n1)
26 |
27 | echo "$var_name<<${random_heredoc_identifier}" >> $GITHUB_ENV
28 | echo "$secret_value" >> $GITHUB_ENV
29 | echo "${random_heredoc_identifier}" >> $GITHUB_ENV
30 | else
31 | # Escape percent signs and newlines when setting the environment variable
32 | escaped_env_var_value=$(echo -n "$secret_value" | sed -z -e 's/%/%25/g' -e 's/\n/%0A/g')
33 | echo "::set-env name=$var_name::$escaped_env_var_value"
34 | fi
35 | done
36 |
--------------------------------------------------------------------------------