mirror of
https://github.com/hashicorp/vault-action.git
synced 2025-11-07 15:16:56 +00:00
Retry core.getIDToken for JWT Auth Method (#574)
* adding generic async retry function and retry core.getIDToken * adding test and build
This commit is contained in:
parent
a1b77a0929
commit
5d06ce836f
3 changed files with 79 additions and 2 deletions
31
dist/index.js
vendored
31
dist/index.js
vendored
|
|
@ -18817,6 +18817,8 @@ const fs = __nccwpck_require__(7147);
|
||||||
const { default: got } = __nccwpck_require__(3061);
|
const { default: got } = __nccwpck_require__(3061);
|
||||||
|
|
||||||
const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token'
|
const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token'
|
||||||
|
const retries = 5
|
||||||
|
const retries_delay = 3000
|
||||||
/***
|
/***
|
||||||
* Authenticate with Vault and retrieve a Vault token that can be used for requests.
|
* Authenticate with Vault and retrieve a Vault token that can be used for requests.
|
||||||
* @param {string} method
|
* @param {string} method
|
||||||
|
|
@ -18847,7 +18849,10 @@ async function retrieveToken(method, client) {
|
||||||
const githubAudience = core.getInput('jwtGithubAudience', { required: false });
|
const githubAudience = core.getInput('jwtGithubAudience', { required: false });
|
||||||
|
|
||||||
if (!privateKey) {
|
if (!privateKey) {
|
||||||
jwt = await core.getIDToken(githubAudience)
|
jwt = await retryAsyncFunction(retries, retries_delay, core.getIDToken, githubAudience)
|
||||||
|
.then((result) => {
|
||||||
|
return result;
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
jwt = generateJwt(privateKey, keyPassword, Number(tokenTtl));
|
jwt = generateJwt(privateKey, keyPassword, Number(tokenTtl));
|
||||||
}
|
}
|
||||||
|
|
@ -18954,6 +18959,30 @@ async function getClientToken(client, method, path, payload) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/***
|
||||||
|
* Generic function for retrying an async function
|
||||||
|
* @param {number} retries
|
||||||
|
* @param {number} delay
|
||||||
|
* @param {Function} func
|
||||||
|
* @param {any[]} args
|
||||||
|
*/
|
||||||
|
async function retryAsyncFunction(retries, delay, func, ...args) {
|
||||||
|
let attempt = 0;
|
||||||
|
while (attempt < retries) {
|
||||||
|
try {
|
||||||
|
const result = await func(...args);
|
||||||
|
return result;
|
||||||
|
} catch (error) {
|
||||||
|
attempt++;
|
||||||
|
if (attempt < retries) {
|
||||||
|
await new Promise(resolve => setTimeout(resolve, delay));
|
||||||
|
} else {
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/***
|
/***
|
||||||
* @typedef {Object} VaultLoginResponse
|
* @typedef {Object} VaultLoginResponse
|
||||||
* @property {{
|
* @property {{
|
||||||
|
|
|
||||||
31
src/auth.js
31
src/auth.js
|
|
@ -5,6 +5,8 @@ const fs = require('fs');
|
||||||
const { default: got } = require('got');
|
const { default: got } = require('got');
|
||||||
|
|
||||||
const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token'
|
const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token'
|
||||||
|
const retries = 5
|
||||||
|
const retries_delay = 3000
|
||||||
/***
|
/***
|
||||||
* Authenticate with Vault and retrieve a Vault token that can be used for requests.
|
* Authenticate with Vault and retrieve a Vault token that can be used for requests.
|
||||||
* @param {string} method
|
* @param {string} method
|
||||||
|
|
@ -35,7 +37,10 @@ async function retrieveToken(method, client) {
|
||||||
const githubAudience = core.getInput('jwtGithubAudience', { required: false });
|
const githubAudience = core.getInput('jwtGithubAudience', { required: false });
|
||||||
|
|
||||||
if (!privateKey) {
|
if (!privateKey) {
|
||||||
jwt = await core.getIDToken(githubAudience)
|
jwt = await retryAsyncFunction(retries, retries_delay, core.getIDToken, githubAudience)
|
||||||
|
.then((result) => {
|
||||||
|
return result;
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
jwt = generateJwt(privateKey, keyPassword, Number(tokenTtl));
|
jwt = generateJwt(privateKey, keyPassword, Number(tokenTtl));
|
||||||
}
|
}
|
||||||
|
|
@ -142,6 +147,30 @@ async function getClientToken(client, method, path, payload) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/***
|
||||||
|
* Generic function for retrying an async function
|
||||||
|
* @param {number} retries
|
||||||
|
* @param {number} delay
|
||||||
|
* @param {Function} func
|
||||||
|
* @param {any[]} args
|
||||||
|
*/
|
||||||
|
async function retryAsyncFunction(retries, delay, func, ...args) {
|
||||||
|
let attempt = 0;
|
||||||
|
while (attempt < retries) {
|
||||||
|
try {
|
||||||
|
const result = await func(...args);
|
||||||
|
return result;
|
||||||
|
} catch (error) {
|
||||||
|
attempt++;
|
||||||
|
if (attempt < retries) {
|
||||||
|
await new Promise(resolve => setTimeout(resolve, delay));
|
||||||
|
} else {
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/***
|
/***
|
||||||
* @typedef {Object} VaultLoginResponse
|
* @typedef {Object} VaultLoginResponse
|
||||||
* @property {{
|
* @property {{
|
||||||
|
|
|
||||||
|
|
@ -85,4 +85,23 @@ describe("test retrival for token", () => {
|
||||||
const url = got.post.mock.calls[0][0]
|
const url = got.post.mock.calls[0][0]
|
||||||
expect(url).toContain('differentK8sPath')
|
expect(url).toContain('differentK8sPath')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it("test retrieval with jwt", async () => {
|
||||||
|
const method = "jwt"
|
||||||
|
const jwtToken = "someTestToken"
|
||||||
|
const testRole = "testRole"
|
||||||
|
const privateKeyRaw = ""
|
||||||
|
|
||||||
|
mockApiResponse()
|
||||||
|
mockInput("role", testRole)
|
||||||
|
mockInput("jwtPrivateKey", privateKeyRaw)
|
||||||
|
core.getIDToken = jest.fn()
|
||||||
|
core.getIDToken.mockReturnValueOnce(jwtToken)
|
||||||
|
const token = await retrieveToken(method, got)
|
||||||
|
expect(token).toEqual(testToken)
|
||||||
|
const payload = got.post.mock.calls[0][1].json
|
||||||
|
expect(payload).toEqual({ jwt: jwtToken, role: testRole })
|
||||||
|
const url = got.post.mock.calls[0][0]
|
||||||
|
expect(url).toContain('jwt')
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue