DigDeo Syspass 客户端
项目描述
digdeo-syspass-客户端
SysPass 服务器的 Python API 客户端 ( https://www.syspass.org/en )
实现的 API
100% 覆盖和 100% 单元测试
很酷，但我需要使用它吗？
API 客户端需要诸如服务器和令牌之类的设置；）它有很多方法可以通过配置文件和/或 ENV 变量注入该设置。
永久配置::
假设这是默认设置，文件config.yml存储在用户空间中。
FreeDedktop 网站上描述了该标准。https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
然后按照推荐和标准，我们将$HOME/.config/digdeo-syspass-client/其用作搜索config.yml文件的默认目录。
您可以$XDG_CONFIG_HOME/digdeo-syspass-client/config.yml通过设置 ENV var syspass_config_dir来更改搜索，然后
$HOME/.config/digdeo-syspass-client/config.yml将变为$syspass_config_dir/config.yml
有关更多信息，请查看 FreeDesktop XDG 推荐。
配置文件
您可以在此处使用任何类型的密钥，在我们的用法中是只读密钥。
syspassclient:
api_url: 'https://you.server.exemple.com/api.php'
api_version: '3.1'
authToken: '######################################################'
tokenPass: '######################################################'
verify_ssl: True
debug: False
debug_level: 0
verbose: False
verbose_level: 0
变量
- syspass_config_dir
- syspass_auth_token
- syspass_token_pass
- syspass_verify_ssl
- syspass_api_url
- syspass_api_version
- syspass_debug
- syspass_debug_LEVEL
- syspass_verbose
- syspass_verbose_level
syspass_config_dir
$HOME/.config/digdeo-syspass-client通过变量的值快捷方式默认路径
syspass_auth_token
快捷方式authToken设置里面的config.yml
syspass_verify_ssl
如果它设置了变量，则 SSL 证书将被验证。
请注意，它是处理 SSL 证书的 Python Requests模块，如果您查看它的模块文档，您将了解如何处理自签名证书。总之，请求模块使用REQUESTS_CA_BUNDLE环境变量，用于获取您系统的 SSL 捆绑证书文件路径。
例子：
export REQUESTS_CA_BUNDLE="/etc/ssl/certs/ca-certificates.crt"
该ca-certificates.crt文件由系统包调用生成，ca-certificates每次添加新的自签名证书时都必须重新生成。
示例：
sudo cp my.cert /usr/local/share/ca-certificates/
sudo update-ca-certificates
对于许多编程语言，添加自签名证书需要通知系统新的自签名证书存在。
SSL Bundle Certificates 是 SSL 常见的东西，不是 Python 自己强加的。如果您想了解更多信息，请返回系统文档以了解有关 SSL 捆绑证书的更多信息。
syspass_token_pass
快捷方式tokenPass设置里面的config.yml
syspass_api_url
快捷方式api_url设置里面的config.yml
syspass_api_version
快捷方式api_version设置里面的config.yml
syspass_debug
快捷方式debug设置里面的config.yml
syspass_debug_LEVEL
快捷方式debug_level设置里面的config.yml
syspass_verbose
快捷方式verbose设置里面的config.yaml
syspass_verbose_level
快捷方式verbose_level设置里面的config.yml
提示
- 如果您想即时更改令牌，则必须使用$syspass_config_dir和子目录结构。
- Syspassclient 可以在没有 config.yml 文件的情况下启动，并且假设使用 Variables ，它允许在 CI 内进行测试。
DigDeo 牙线团队 - 2020
