Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: npm token command support (#1427)
* feat: support for npm token This is an effor of: This commit intent to provide npm token support. https: //github.com//issues/541 https: //github.com//pull/1271 https: //github.com/verdaccio/local-storage/pull/168 Co-Authored-By: Manuel Spigolon <behemoth89@gmail.com> Co-Authored-By: Juan Gabriel Jiménez <juangabreil@gmail.com> * chore: update secrets baselines Co-Authored-By: Liran Tal <liran.tal@gmail.com> * chore: update lock file * chore: add logger mock methods * chore: update @verdaccio/types * refactor: unit test was flacky adapt the pkg access to the new configuration setup * refactor: add plugin methods validation * test: add test for aesEncrypt * chore: update local-storage dependency * chore: add support for experimetns token will be part of the experiment lists * chore: increase timeout * chore: increase timeout threshold * chore: update nock * chore: update dependencies * chore: update eslint config * chore: update dependencies * test: add unit test for npm token * chore: update readme
- Loading branch information
1 parent
962d5d5
commit dbf2017
Showing
35 changed files
with
1,557 additions
and
1,025 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| "presets": [["@verdaccio", {"typescript": true}]] | ||
| "presets": [["@verdaccio"]] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| always-auth = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| import _ from 'lodash'; | ||
| import { HTTP_STATUS, SUPPORT_ERRORS } from '../../../../lib/constants'; | ||
| import {ErrorCode, mask} from '../../../../lib/utils'; | ||
| import { getApiToken } from '../../../../lib/auth-utils'; | ||
| import { stringToMD5 } from '../../../../lib/crypto-utils'; | ||
| import { logger } from '../../../../lib/logger'; | ||
|
|
||
| import { Response, Router } from 'express'; | ||
| import {$NextFunctionVer, $RequestExtend, IAuth, IStorageHandler} from '../../../../../types'; | ||
| import { Config, RemoteUser, Token } from '@verdaccio/types'; | ||
|
|
||
| export type NormalizeToken = Token & { | ||
| created: string; | ||
| }; | ||
|
|
||
| function normalizeToken(token: Token): NormalizeToken { | ||
| return { | ||
| ...token, | ||
| created: new Date(token.created).toISOString(), | ||
| }; | ||
| }; | ||
|
|
||
| // https://github.com/npm/npm-profile/blob/latest/lib/index.js | ||
| export default function(route: Router, auth: IAuth, storage: IStorageHandler, config: Config) { | ||
| route.get('/-/npm/v1/tokens', async function(req: $RequestExtend, res: Response, next: $NextFunctionVer) { | ||
| const { name } = req.remote_user; | ||
|
|
||
| if (_.isNil(name) === false) { | ||
| try { | ||
| const tokens = await storage.readTokens({user: name}); | ||
| const totalTokens = tokens.length; | ||
| logger.debug({totalTokens}, 'token list retrieved: @{totalTokens}'); | ||
|
|
||
| res.status(HTTP_STATUS.OK); | ||
| return next({ | ||
| objects: tokens.map(normalizeToken), | ||
| urls: { | ||
| next: '', // TODO: pagination? | ||
| }, | ||
| }); | ||
| } catch (error) { | ||
| logger.error({ error: error.msg }, 'token list has failed: @{error}'); | ||
| return next(ErrorCode.getCode(HTTP_STATUS.INTERNAL_ERROR, error.message)); | ||
| } | ||
| } else { | ||
| return next(ErrorCode.getUnauthorized()); | ||
| } | ||
| }); | ||
|
|
||
| route.post('/-/npm/v1/tokens', function(req: $RequestExtend, res: Response, next: $NextFunctionVer) { | ||
| const { password, readonly, cidr_whitelist } = req.body; | ||
| const { name } = req.remote_user; | ||
|
|
||
| if (!_.isBoolean(readonly) || !_.isArray(cidr_whitelist)) { | ||
| return next(ErrorCode.getCode(HTTP_STATUS.BAD_DATA, SUPPORT_ERRORS.PARAMETERS_NOT_VALID)); | ||
| } | ||
|
|
||
| auth.authenticate(name, password, async (err, user: RemoteUser) => { | ||
| if (err) { | ||
| const errorCode = err.message ? HTTP_STATUS.UNAUTHORIZED : HTTP_STATUS.INTERNAL_ERROR; | ||
| return next(ErrorCode.getCode(errorCode, err.message)); | ||
| } else { | ||
| req.remote_user = user; | ||
|
|
||
| if (!_.isFunction(storage.saveToken)) { | ||
| return next(ErrorCode.getCode(HTTP_STATUS.NOT_IMPLEMENTED, SUPPORT_ERRORS.STORAGE_NOT_IMPLEMENT)); | ||
| } | ||
|
|
||
| try { | ||
| const token = await getApiToken(auth, config, user, password); | ||
| const key = stringToMD5(token); | ||
| // TODO: use a utility here | ||
| const maskedToken = mask(token, 5); | ||
| const created = new Date().getTime(); | ||
|
|
||
| /** | ||
| * cidr_whitelist: is not being used, we pass it through | ||
| * token: we do not store the real token (it is generated once and retrieved to the user), just a mask of it. | ||
| */ | ||
| const saveToken: Token = { | ||
| user: name, | ||
| token: maskedToken, | ||
| key, | ||
| cidr: cidr_whitelist, | ||
| readonly, | ||
| created, | ||
| }; | ||
|
|
||
| await storage.saveToken(saveToken); | ||
| logger.debug({ key, name }, 'token @{key} was created for user @{name}'); | ||
| return next(normalizeToken({ | ||
| token, | ||
| user: name, | ||
| key: saveToken.key, | ||
| cidr: cidr_whitelist, | ||
| readonly, | ||
| created: saveToken.created, | ||
| })); | ||
| } catch (error) { | ||
| logger.error({ error: error.msg }, 'token creation has failed: @{error}'); | ||
| return next(ErrorCode.getCode(HTTP_STATUS.INTERNAL_ERROR, error.message)); | ||
| } | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| route.delete('/-/npm/v1/tokens/token/:tokenKey', async (req: $RequestExtend, res: Response, next: $NextFunctionVer) => { | ||
| const { params: { tokenKey }} = req; | ||
| const { name } = req.remote_user; | ||
|
|
||
| if (_.isNil(name) === false) { | ||
| logger.debug({name}, '@{name} has requested remove a token'); | ||
| try { | ||
| await storage.deleteToken(name, tokenKey); | ||
| logger.info({ tokenKey, name }, 'token id @{tokenKey} was revoked for user @{name}'); | ||
| return next({}); | ||
| } catch(error) { | ||
| logger.error({ error: error.msg }, 'token creation has failed: @{error}'); | ||
| return next(ErrorCode.getCode(HTTP_STATUS.INTERNAL_ERROR, error.message)); | ||
| } | ||
| } else { | ||
| return next(ErrorCode.getUnauthorized()); | ||
| } | ||
| }); | ||
| } |
Oops, something went wrong.