Vault Field

The module provides a new field type VaultSecretField. Thanks to this field the filled data will be stored in the vault and the secret path will be stored in the database. The field can be used in any model, including res.config.settings to store module settings.

      # Examples of working with vault fields.
      # model.py
      from odoo.addons.vault_connector.fields import VaultSecretField
      from odoo.addons.vault_connector.vault.types import KeySecretType, KeyPairSecretType, LoginPasswordType

      class YourModel(models.Model):
          _name = "your_model"

          secret = VaultSecretField(secret_type=KeySecretType.type)
          accesses = VaultSecretField(secret_type=KeyPairSecretType.type)
          login_accesses = VaultSecretField(secret_type=LoginPasswordType.type)

          def _get_secret(self):
            """Get secret from vault"""
            self.ensure_one()
            return self.secret.get_secret()

          def _get_accesses(self):
            """Get accesses from vault"""
            self.ensure_one()
            return self.accesses.get_secret()

          def _get_login_accesses(self):
            """Get login/password from vault"""
            self.ensure_one()
            return self.login_accesses.get_secret()

      # view.xml
      <field name=“arch” type=“xml”>
          ....
          <field name=“secret” />
          <field name=“accesses” />
          <field name=“login_accesses” />
          ....
      </field>
      

UI view

UI after filling and saving data

How it's look like in DB

How it's look like in Vault

Extra Example

      # Example of working with vault fields for res.config.settings model:
      # model
      class ResConfigSettings(models.TransientModel):
          _inherit = “res.config.settings”

          secret = VaultSecretField(secret_type=KeySecretType.type)
          accesses = VaultSecretField(secret_type=KeyPairSecretType.type)
          login_accesses = VaultSecretField(secret_type=LoginPasswordType.type)

          def _get_secret(self):
              secret = self.env["ir.config_parameter"].sudo().get_secret_param("secret")
              accesses = self.env["ir.config_parameter"].sudo().get_secret_param("accesses")
              login_accesses = self.env["ir.config_parameter"].sudo().get_secret_param("login_accesses")

      # view
      <field name=“arch” type=“xml”>
          ....
          <field name=“secret” />
          <field name=“accesses” />
          <field name=“login_accesses” />
          ....
      </field>
      

Communicate with Vault

The module provides a VaultSecret API class that performs standard CRUD interaction with a vault.

# Examples of working with the API class:
# Create
new_secret = VaultSecret.save_secret(
    LoginPasswordType.type, login=login, password=password
)
# or
new_secret = VaultSecret(path="custom_path", secret_type=LoginPasswordType)
new_secret.write_secret({"login": login, "password": password})
# Get
secret = new_secret.get_secret()
login = secret['login']
password = secret['password']
# Write
new_secret.write_secret({"login": login, "password": password})
# Delete
new_secret.delete_secret()