存储安全 Python

StoredSafe REST-like API 的透明 Python 包装器。

API 响应签名和更高级参数的完整文档可以在StoredSafe API 文档中找到。

安装

从 pypi安装storedsafe 。

pip install storedsafe

例子

登录

# Initial configuration
api = StoredSafe(host='my.site.com', apikey='my-apikey')

# Login using TOTP
api.login_totp(username='my-username', passphrase='my-passphrase', otp='my-timed-otp')

# Login using YubiKey
api.login_yubikey(username='my-username', passphrase='my-passphrase', otp='my-yubico-otp')

如果您已经有令牌，您可以跳过上一步，直接输入令牌。

api = StoredSafe(host='my.site.com', token='my-storedsafe-token')

如果您使用的是StoredSafe 令牌处理程序，您还可以从 rc 文件中检索主机、apikey 和令牌：

# Default rc location
api = StoredSafe.from_rc()

# Custom rc location
api = StoredSafe.from_rc(path='/path/to/rc-file')

编程风格

对于创建和编辑方法，参数可以很容易地作为关键字参数传递，例如：

api.create_vault(vaultname="My Vault", policy=7, description="Sercret")

或者，如果您以 dict 格式接收数据，则可以将其解压缩到方法中：

data = function_that_returns_data()
api.create_vault(**data)

返回类型

所有方法的返回值都是一个requests响应对象。获取成功响应对象返回的数据，可以使用json()函数：

r = api.list_vaults()
if <= 403:
    data = res.json()
    if res.ok:
        print(data['VAULTS'])
    else:
        print(data['ERRORS'])

用法

from storedsafe import StoredSafe

# Manual configuration
api = StoredSafe(host='my.site.com', apikey='my-apikey', token='my-storedsafe-token')

# Automatic configuration
api = StoredSafe.from_rc() # Use default path ~/.storedsafe-client.rc
api = StoredSafe.from_rc(path='/path/to/rc-file')

# Auth
api.login_totp(username='my-username', passphrase='my-passphrase', otp='my-otp')
api.login_yubikey(username='my-username', passphrase='my-passphrase', otp='my-otp')
api.logout()
api.check()

# Vaults
api.list_vaults()
api.vault_objects(vault_id) # String or integer
api.vault_members(vault_id)
api.create_vault(**params) # See parameters in API documentation
api.edit_vault(vault_id, **params)
api.delete_vault(vault_id)

# Objects
api.get_object(object_id) # String or integer
api.get_object(object_id, children=True) # children False by default
api.decrypt_object(object_id)
api.create_object(**params)
api.edit_object(object_id, **params)
api.delete_object(object_id)

# Users
api.list_users() # List all users
api.list_users(search_string) # Search for any user matching search_string
api.get_user(user_id)
api.create_user(**params)
api.edit_user(user_id, **params)
api.delete_user(user_id)

# Utils
api.status_values()
api.password_policies()
api.version()
api.generate_password() # Use default settings
api.generate_password(**params)