CBFS Vault 2020 Python Edition

Questions / Feedback?

cache_file_password Method

Caches an encryption password to use the next time a file or alternate stream is accessed.


def cache_file_password(file_name: str, password: str) -> None: ...


This temporarily caches an encryption password so that it can be used the next time the file or alternate stream specified by FileName is accessed. The specified password is automatically removed from the cache as soon as one of the following things occur:

  • The password is used to access the file or alternate stream.
  • The password for the file or alternate stream is changed.
  • The vault is closed.

The value passed for FileName must be a vault-local absolute path.

The Password parameter specifies the password to cache. It must match the one last used to encrypt the specified file or alternate stream, otherwise this method raises an exception.

As an alternative to using this method, applications can provide a default file encryption password using the default_file_password property, and/or provide such passwords dynamically using the on_file_password_needed event.

Note: This method can only be called when active is True.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 Python Edition - Version 20.0 [Build 7982]