mirror of
https://github.com/hashicorp/vault-action.git
synced 2025-11-07 15:16:56 +00:00
feat: added double asterisk wildcard selector to prevent uppercasing of keys before exporting envs
This commit is contained in:
parent
47dbc643a8
commit
e9b79cbe45
7 changed files with 82 additions and 22 deletions
10
README.md
10
README.md
|
|
@ -399,6 +399,16 @@ with:
|
||||||
secret/data/ci/aws * | MYAPP_ ;
|
secret/data/ci/aws * | MYAPP_ ;
|
||||||
```
|
```
|
||||||
|
|
||||||
|
When using the `exportEnv` option all exported keys will be normalized to uppercase. For example, the key `SecretKey` would be exported as `MYAPP_SECRETKEY`. You disable uppercase normalization by specifying double asterisks `**` in the selector path:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
with:
|
||||||
|
secrets: |
|
||||||
|
secret/data/ci/aws ** | MYAPP_ ;
|
||||||
|
```
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
|
||||||
## Other Secret Engines
|
## Other Secret Engines
|
||||||
|
|
||||||
Vault Action currently supports retrieving secrets from any engine where secrets
|
Vault Action currently supports retrieving secrets from any engine where secrets
|
||||||
|
|
|
||||||
42
dist/index.js
vendored
42
dist/index.js
vendored
|
|
@ -9686,6 +9686,13 @@ const dateTime = (function () {
|
||||||
if (offset === 0 && markerSpec.presentation2 === 't') {
|
if (offset === 0 && markerSpec.presentation2 === 't') {
|
||||||
componentValue = 'Z';
|
componentValue = 'Z';
|
||||||
}
|
}
|
||||||
|
} else if (markerSpec.component === 'P') {
|
||||||
|
// §9.8.4.7 Formatting Other Components
|
||||||
|
// Formatting P for am/pm
|
||||||
|
// getDateTimeFragment() always returns am/pm lower case so check for UPPER here
|
||||||
|
if (markerSpec.names === tcase.UPPER) {
|
||||||
|
componentValue = componentValue.toUpperCase();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return componentValue;
|
return componentValue;
|
||||||
};
|
};
|
||||||
|
|
@ -13501,6 +13508,13 @@ var jsonata = (function() {
|
||||||
}
|
}
|
||||||
for(var ii = 0; ii < matches.length; ii++) {
|
for(var ii = 0; ii < matches.length; ii++) {
|
||||||
var match = matches[ii];
|
var match = matches[ii];
|
||||||
|
if (match && (match.isPrototypeOf(result) || match instanceof Object.constructor)) {
|
||||||
|
throw {
|
||||||
|
code: "D1010",
|
||||||
|
stack: (new Error()).stack,
|
||||||
|
position: expr.position
|
||||||
|
};
|
||||||
|
}
|
||||||
// evaluate the update value for each match
|
// evaluate the update value for each match
|
||||||
var update = await evaluate(expr.update, match, environment);
|
var update = await evaluate(expr.update, match, environment);
|
||||||
// update must be an object
|
// update must be an object
|
||||||
|
|
@ -13747,7 +13761,7 @@ var jsonata = (function() {
|
||||||
if (typeof err.token == 'undefined' && typeof proc.token !== 'undefined') {
|
if (typeof err.token == 'undefined' && typeof proc.token !== 'undefined') {
|
||||||
err.token = proc.token;
|
err.token = proc.token;
|
||||||
}
|
}
|
||||||
err.position = proc.position;
|
err.position = proc.position || err.position;
|
||||||
}
|
}
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
|
|
@ -14180,6 +14194,7 @@ var jsonata = (function() {
|
||||||
"T1007": "Attempted to partially apply a non-function. Did you mean ${{{token}}}?",
|
"T1007": "Attempted to partially apply a non-function. Did you mean ${{{token}}}?",
|
||||||
"T1008": "Attempted to partially apply a non-function",
|
"T1008": "Attempted to partially apply a non-function",
|
||||||
"D1009": "Multiple key definitions evaluate to same key: {{value}}",
|
"D1009": "Multiple key definitions evaluate to same key: {{value}}",
|
||||||
|
"D1010": "Attempted to access the Javascript object prototype", // Javascript specific
|
||||||
"T1010": "The matcher function argument passed to function {{token}} does not return the correct object structure",
|
"T1010": "The matcher function argument passed to function {{token}} does not return the correct object structure",
|
||||||
"T2001": "The left side of the {{token}} operator must evaluate to a number",
|
"T2001": "The left side of the {{token}} operator must evaluate to a number",
|
||||||
"T2002": "The right side of the {{token}} operator must evaluate to a number",
|
"T2002": "The right side of the {{token}} operator must evaluate to a number",
|
||||||
|
|
@ -18520,7 +18535,7 @@ const command = __nccwpck_require__(7351);
|
||||||
const got = (__nccwpck_require__(3061)["default"]);
|
const got = (__nccwpck_require__(3061)["default"]);
|
||||||
const jsonata = __nccwpck_require__(4245);
|
const jsonata = __nccwpck_require__(4245);
|
||||||
const { normalizeOutputKey } = __nccwpck_require__(1608);
|
const { normalizeOutputKey } = __nccwpck_require__(1608);
|
||||||
const { WILDCARD } = __nccwpck_require__(4438);
|
const { WILDCARD, WILDCARD_UPPERCASE } = __nccwpck_require__(4438);
|
||||||
|
|
||||||
const { auth: { retrieveToken }, secrets: { getSecrets } } = __nccwpck_require__(4351);
|
const { auth: { retrieveToken }, secrets: { getSecrets } } = __nccwpck_require__(4351);
|
||||||
|
|
||||||
|
|
@ -18690,7 +18705,7 @@ function parseSecretsInput(secretsInput) {
|
||||||
const selectorAst = jsonata(selectorQuoted).ast();
|
const selectorAst = jsonata(selectorQuoted).ast();
|
||||||
const selector = selectorQuoted.replace(new RegExp('"', 'g'), '');
|
const selector = selectorQuoted.replace(new RegExp('"', 'g'), '');
|
||||||
|
|
||||||
if (selector !== WILDCARD && (selectorAst.type !== "path" || selectorAst.steps[0].stages) && selectorAst.type !== "string" && !outputVarName) {
|
if (selector !== WILDCARD && selector !== WILDCARD_UPPERCASE && (selectorAst.type !== "path" || selectorAst.steps[0].stages) && selectorAst.type !== "string" && !outputVarName) {
|
||||||
throw Error(`You must provide a name for the output key when using json selectors. Input: "${secret}"`);
|
throw Error(`You must provide a name for the output key when using json selectors. Input: "${secret}"`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -18767,7 +18782,7 @@ async function retrieveToken(method, client) {
|
||||||
switch (method) {
|
switch (method) {
|
||||||
case 'approle': {
|
case 'approle': {
|
||||||
const vaultRoleId = core.getInput('roleId', { required: true });
|
const vaultRoleId = core.getInput('roleId', { required: true });
|
||||||
const vaultSecretId = core.getInput('secretId', { required: true });
|
const vaultSecretId = core.getInput('secretId', { required: false });
|
||||||
return await getClientToken(client, method, path, { role_id: vaultRoleId, secret_id: vaultSecretId });
|
return await getClientToken(client, method, path, { role_id: vaultRoleId, secret_id: vaultSecretId });
|
||||||
}
|
}
|
||||||
case 'github': {
|
case 'github': {
|
||||||
|
|
@ -18914,12 +18929,15 @@ module.exports = {
|
||||||
/***/ 4438:
|
/***/ 4438:
|
||||||
/***/ ((module) => {
|
/***/ ((module) => {
|
||||||
|
|
||||||
const WILDCARD = '*';
|
const WILDCARD_UPPERCASE = '*';
|
||||||
|
const WILDCARD = '**';
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
WILDCARD
|
WILDCARD,
|
||||||
|
WILDCARD_UPPERCASE,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
/***/ }),
|
/***/ }),
|
||||||
|
|
||||||
/***/ 4351:
|
/***/ 4351:
|
||||||
|
|
@ -18939,7 +18957,7 @@ module.exports = {
|
||||||
/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
|
/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
|
||||||
|
|
||||||
const jsonata = __nccwpck_require__(4245);
|
const jsonata = __nccwpck_require__(4245);
|
||||||
const { WILDCARD } = __nccwpck_require__(4438);
|
const { WILDCARD, WILDCARD_UPPERCASE} = __nccwpck_require__(4438);
|
||||||
const { normalizeOutputKey } = __nccwpck_require__(1608);
|
const { normalizeOutputKey } = __nccwpck_require__(1608);
|
||||||
const core = __nccwpck_require__(2186);
|
const core = __nccwpck_require__(2186);
|
||||||
|
|
||||||
|
|
@ -18966,6 +18984,7 @@ const core = __nccwpck_require__(2186);
|
||||||
async function getSecrets(secretRequests, client, ignoreNotFound) {
|
async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
const responseCache = new Map();
|
const responseCache = new Map();
|
||||||
let results = [];
|
let results = [];
|
||||||
|
let upperCaseEnv = false;
|
||||||
|
|
||||||
for (const secretRequest of secretRequests) {
|
for (const secretRequest of secretRequests) {
|
||||||
let { path, selector } = secretRequest;
|
let { path, selector } = secretRequest;
|
||||||
|
|
@ -18999,7 +19018,8 @@ async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
|
|
||||||
body = JSON.parse(body);
|
body = JSON.parse(body);
|
||||||
|
|
||||||
if (selector == WILDCARD) {
|
if (selector === WILDCARD || selector === WILDCARD_UPPERCASE) {
|
||||||
|
upperCaseEnv = selector === WILDCARD_UPPERCASE;
|
||||||
let keys = body.data;
|
let keys = body.data;
|
||||||
if (body.data["data"] != undefined) {
|
if (body.data["data"] != undefined) {
|
||||||
keys = keys.data;
|
keys = keys.data;
|
||||||
|
|
@ -19018,7 +19038,7 @@ async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
}
|
}
|
||||||
|
|
||||||
newRequest.outputVarName = normalizeOutputKey(newRequest.outputVarName);
|
newRequest.outputVarName = normalizeOutputKey(newRequest.outputVarName);
|
||||||
newRequest.envVarName = normalizeOutputKey(newRequest.envVarName,true);
|
newRequest.envVarName = normalizeOutputKey(newRequest.envVarName, upperCaseEnv);
|
||||||
|
|
||||||
// JSONata field references containing reserved tokens should
|
// JSONata field references containing reserved tokens should
|
||||||
// be enclosed in backticks
|
// be enclosed in backticks
|
||||||
|
|
@ -19127,12 +19147,12 @@ module.exports = {
|
||||||
* @param {string} dataKey
|
* @param {string} dataKey
|
||||||
* @param {boolean=} isEnvVar
|
* @param {boolean=} isEnvVar
|
||||||
*/
|
*/
|
||||||
function normalizeOutputKey(dataKey, isEnvVar = false) {
|
function normalizeOutputKey(dataKey, upperCase = false) {
|
||||||
let outputKey = dataKey
|
let outputKey = dataKey
|
||||||
.replace(".", "__")
|
.replace(".", "__")
|
||||||
.replace(new RegExp("-", "g"), "")
|
.replace(new RegExp("-", "g"), "")
|
||||||
.replace(/[^\p{L}\p{N}_-]/gu, "");
|
.replace(/[^\p{L}\p{N}_-]/gu, "");
|
||||||
if (isEnvVar) {
|
if (upperCase) {
|
||||||
outputKey = outputKey.toUpperCase();
|
outputKey = outputKey.toUpperCase();
|
||||||
}
|
}
|
||||||
return outputKey;
|
return outputKey;
|
||||||
|
|
|
||||||
|
|
@ -313,7 +313,7 @@ describe('integration', () => {
|
||||||
expect(core.exportVariable).toBeCalledWith('FOO', 'bar');
|
expect(core.exportVariable).toBeCalledWith('FOO', 'bar');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('wildcard supports cubbyhole', async () => {
|
it('wildcard supports cubbyhole with uppercase transform', async () => {
|
||||||
mockInput('/cubbyhole/test *');
|
mockInput('/cubbyhole/test *');
|
||||||
|
|
||||||
await exportSecrets();
|
await exportSecrets();
|
||||||
|
|
@ -323,6 +323,32 @@ describe('integration', () => {
|
||||||
expect(core.exportVariable).toBeCalledWith('FOO', 'bar');
|
expect(core.exportVariable).toBeCalledWith('FOO', 'bar');
|
||||||
expect(core.exportVariable).toBeCalledWith('ZIP', 'zap');
|
expect(core.exportVariable).toBeCalledWith('ZIP', 'zap');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('wildcard supports cubbyhole with no change in case', async () => {
|
||||||
|
mockInput('/cubbyhole/test **');
|
||||||
|
|
||||||
|
await exportSecrets();
|
||||||
|
|
||||||
|
expect(core.exportVariable).toBeCalledTimes(2);
|
||||||
|
|
||||||
|
expect(core.exportVariable).toBeCalledWith('foo', 'bar');
|
||||||
|
expect(core.exportVariable).toBeCalledWith('zip', 'zap');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('wildcard supports cubbyhole with mixed case change', async () => {
|
||||||
|
mockInput(`
|
||||||
|
/cubbyhole/test * ;
|
||||||
|
/cubbyhole/test **`);
|
||||||
|
|
||||||
|
await exportSecrets();
|
||||||
|
|
||||||
|
expect(core.exportVariable).toBeCalledTimes(4);
|
||||||
|
|
||||||
|
expect(core.exportVariable).toBeCalledWith('FOO', 'bar');
|
||||||
|
expect(core.exportVariable).toBeCalledWith('ZIP', 'zap');
|
||||||
|
expect(core.exportVariable).toBeCalledWith('foo', 'bar');
|
||||||
|
expect(core.exportVariable).toBeCalledWith('zip', 'zap');
|
||||||
|
});
|
||||||
|
|
||||||
it('caches responses', async () => {
|
it('caches responses', async () => {
|
||||||
mockInput(`
|
mockInput(`
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ const command = require('@actions/core/lib/command');
|
||||||
const got = require('got').default;
|
const got = require('got').default;
|
||||||
const jsonata = require('jsonata');
|
const jsonata = require('jsonata');
|
||||||
const { normalizeOutputKey } = require('./utils');
|
const { normalizeOutputKey } = require('./utils');
|
||||||
const { WILDCARD } = require('./constants');
|
const { WILDCARD, WILDCARD_UPPERCASE } = require('./constants');
|
||||||
|
|
||||||
const { auth: { retrieveToken }, secrets: { getSecrets } } = require('./index');
|
const { auth: { retrieveToken }, secrets: { getSecrets } } = require('./index');
|
||||||
|
|
||||||
|
|
@ -174,7 +174,7 @@ function parseSecretsInput(secretsInput) {
|
||||||
const selectorAst = jsonata(selectorQuoted).ast();
|
const selectorAst = jsonata(selectorQuoted).ast();
|
||||||
const selector = selectorQuoted.replace(new RegExp('"', 'g'), '');
|
const selector = selectorQuoted.replace(new RegExp('"', 'g'), '');
|
||||||
|
|
||||||
if (selector !== WILDCARD && (selectorAst.type !== "path" || selectorAst.steps[0].stages) && selectorAst.type !== "string" && !outputVarName) {
|
if (selector !== WILDCARD && selector !== WILDCARD_UPPERCASE && (selectorAst.type !== "path" || selectorAst.steps[0].stages) && selectorAst.type !== "string" && !outputVarName) {
|
||||||
throw Error(`You must provide a name for the output key when using json selectors. Input: "${secret}"`);
|
throw Error(`You must provide a name for the output key when using json selectors. Input: "${secret}"`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
const WILDCARD = '*';
|
const WILDCARD_UPPERCASE = '*';
|
||||||
|
const WILDCARD = '**';
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
WILDCARD
|
WILDCARD,
|
||||||
};
|
WILDCARD_UPPERCASE,
|
||||||
|
};
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
const jsonata = require("jsonata");
|
const jsonata = require("jsonata");
|
||||||
const { WILDCARD } = require("./constants");
|
const { WILDCARD, WILDCARD_UPPERCASE} = require("./constants");
|
||||||
const { normalizeOutputKey } = require("./utils");
|
const { normalizeOutputKey } = require("./utils");
|
||||||
const core = require('@actions/core');
|
const core = require('@actions/core');
|
||||||
|
|
||||||
|
|
@ -26,6 +26,7 @@ const core = require('@actions/core');
|
||||||
async function getSecrets(secretRequests, client, ignoreNotFound) {
|
async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
const responseCache = new Map();
|
const responseCache = new Map();
|
||||||
let results = [];
|
let results = [];
|
||||||
|
let upperCaseEnv = false;
|
||||||
|
|
||||||
for (const secretRequest of secretRequests) {
|
for (const secretRequest of secretRequests) {
|
||||||
let { path, selector } = secretRequest;
|
let { path, selector } = secretRequest;
|
||||||
|
|
@ -59,7 +60,8 @@ async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
|
|
||||||
body = JSON.parse(body);
|
body = JSON.parse(body);
|
||||||
|
|
||||||
if (selector == WILDCARD) {
|
if (selector === WILDCARD || selector === WILDCARD_UPPERCASE) {
|
||||||
|
upperCaseEnv = selector === WILDCARD_UPPERCASE;
|
||||||
let keys = body.data;
|
let keys = body.data;
|
||||||
if (body.data["data"] != undefined) {
|
if (body.data["data"] != undefined) {
|
||||||
keys = keys.data;
|
keys = keys.data;
|
||||||
|
|
@ -78,7 +80,7 @@ async function getSecrets(secretRequests, client, ignoreNotFound) {
|
||||||
}
|
}
|
||||||
|
|
||||||
newRequest.outputVarName = normalizeOutputKey(newRequest.outputVarName);
|
newRequest.outputVarName = normalizeOutputKey(newRequest.outputVarName);
|
||||||
newRequest.envVarName = normalizeOutputKey(newRequest.envVarName,true);
|
newRequest.envVarName = normalizeOutputKey(newRequest.envVarName, upperCaseEnv);
|
||||||
|
|
||||||
// JSONata field references containing reserved tokens should
|
// JSONata field references containing reserved tokens should
|
||||||
// be enclosed in backticks
|
// be enclosed in backticks
|
||||||
|
|
|
||||||
|
|
@ -3,12 +3,12 @@
|
||||||
* @param {string} dataKey
|
* @param {string} dataKey
|
||||||
* @param {boolean=} isEnvVar
|
* @param {boolean=} isEnvVar
|
||||||
*/
|
*/
|
||||||
function normalizeOutputKey(dataKey, isEnvVar = false) {
|
function normalizeOutputKey(dataKey, upperCase = false) {
|
||||||
let outputKey = dataKey
|
let outputKey = dataKey
|
||||||
.replace(".", "__")
|
.replace(".", "__")
|
||||||
.replace(new RegExp("-", "g"), "")
|
.replace(new RegExp("-", "g"), "")
|
||||||
.replace(/[^\p{L}\p{N}_-]/gu, "");
|
.replace(/[^\p{L}\p{N}_-]/gu, "");
|
||||||
if (isEnvVar) {
|
if (upperCase) {
|
||||||
outputKey = outputKey.toUpperCase();
|
outputKey = outputKey.toUpperCase();
|
||||||
}
|
}
|
||||||
return outputKey;
|
return outputKey;
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue