7.2 KiB
id | title |
---|---|
packages | 包的访问 |
This is a series of constraints that allow or restrict access to the local storage based on specific criteria.
安全约束构建于被使用的插件上,在默认情况下,verdaccio
使用htpasswd 插件。 如果你使用不同的插件,行为可能会有所不同。 默认插件自己并不处理allow_access
和allow_publish
,它使用内部回退功能以防止插件尚未就绪。
关于权限的更多信息,请访问维基文档的认证部分。
用法
packages:
# scoped packages
'@scope/*':
access: $all
publish: $all
proxy: server2
'private-*':
access: $all
publish: $all
proxy: uplink1
'**':
# allow all users (including non-authenticated users) to read and
# publish all packages
access: $all
publish: $all
proxy: uplink2
如果未进行任何设置,默认值则会被保留
packages:
'**':
access: $all
publish: $authenticated
The list internal groups handled by verdaccio
are:
'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous'
如果htpasswd
返回用户名为组,所有用户,不管匿名与否,都会分别接到该组的权限以及插件提供的组。 例如,如果你以npmUser
身份登录,组列表为。
// groups without '$' are going to be deprecated eventually
'$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser'
如果你想要保护你所在组的特定包,你需要做如下工作。 我们来使用一个包含所有前缀为npmuser-
的包的Regex
。 We recommend using a prefix for your packages, in that way it will be easier to protect them.
packages:
'npmuser-*':
access: npmuser
publish: npmuser
重启verdaccio
并在命令行中尝试安装npmuser-core
。
$ npm install npmuser-core
npm install npmuser-core
npm ERR! code E403
npm ERR! 403 Forbidden: npmuser-core@latest
npm ERR! A complete log of this run can be found in:
npm ERR! /Users/user/.npm/_logs/2017-07-02T12_20_14_834Z-debug.log
你可以使用不同的插件认证来更改现有行为。 verdaccio
只是检查试图访问或发布特定包的用户是否属于正确的组。
Please note that if you set the access
permission of a package to something that requires Verdaccio to check your identity, for example $authenticated
, npm does not send your access key by default when fetching packages. This means all requests for downloading packages will be rejected as they are made anonymously even if you have logged in. To make npm include you access key with all requests, you should set the always-auth npm setting to true on any client machines. This can be accomplished by running:
$ npm config set always-auth=true
设置多个组
Defining multiple access groups is fairly easy, just define them with a white space between them.
'company-*':
access: admin internal
publish: admin
proxy: server1
'supersecret-*':
access: secret super-secret-area ultra-secret-area
publish: secret ultra-secret-area
proxy: server1
阻止对一组包的访问
If you want to block the access/publish to a specific group of packages. Just do not define access
and publish
.
packages:
'old-*':
'**':
access: $all
publish: $authenticated
阻止代理一组特定包
You might want to block one or several packages from fetching from remote repositories., but, at the same time, allow others to access different uplinks.
Let's see the following example:
packages:
'jquery':
access: $all
publish: $all
'my-company-*':
access: $all
publish: $authenticated
'@my-local-scope/*':
access: $all
publish: $authenticated
'**':
access: $all
publish: $authenticated
proxy: npmjs
Let's describe what we want with the above example:
- 我想要自己的服务器上放置
jquery
依赖库但需要避免代理它。 - 我想要所有和
my-company-*
匹配的依赖库但我需要避免代理它们。 - 我想要在
my-local-scope
范围内的所有依赖库但我需要避免代理它们。 - 我想要代理所有剩余的依赖库。
Be aware that the order of your packages definitions is important and always use double wilcard. Because if you do not include it verdaccio
will include it for you and the way that your dependencies are resolved will be affected.
Use multiple uplinks
You may assign multiple uplinks for use as a proxy to use in the case of failover, or where there may be other private registries in use.
'**':
access: $all
publish: $authenticated
proxy: npmjs uplink2
Unpublishing Packages
The property publish
handle permissions for npm publish
and npm unpublish
. But, if you want to be more specific, you can use the property unpublish
in your package access section, for instance:
packages:
'jquery':
access: $all
publish: $all
unpublish: root
'my-company-*':
access: $all
publish: $authenticated
unpublish:
'@my-local-scope/*':
access: $all
publish: $authenticated
# unpublish: property commented out
'**':
access: $all
publish: $authenticated
proxy: npmjs
In the previous example, the behaviour would be described:
- all users can publish the
jquery
package, but only the userroot
would be able to unpublish any version. - only authenticated users can publish
my-company-*
packages, but nobody would be allowed to unpublish them. - If
unpublish
is commented out, the access will be granted or denied by thepublish
definition.
配置
You can define mutiple packages
and each of them must have an unique Regex
. The syntax is based on minimatch glob expressions.
属性 | 类型 | 必须的 | 示例 | 支持 | 描述 |
---|---|---|---|---|---|
access | string | No | $all | all | 定义允许访问包的组 |
publish | string | No | $authenticated | all | 定义允许发布的组 |
proxy | string | No | npmjs | all | 针对特定的uplink限制查找 |
storage | 字符串 | No | 字符串 | /some-folder |
it creates a subfolder whithin the storage folder for each package access |
我们强烈建议不要再使用已被弃用的allow_access/allow_publish 和 proxy_access,它们很快就会被移除,请使用它们的精简版本 (access/publish/proxy) 。
If you want more information about how to use the storage property, please refer to this comment.