CBFS Filter 2020 Python Edition

Questions / Feedback?

User Mode API

Note: The user-mode API must be deployed to end-user systems together with the kernel-mode drivers; the version of the kernel-mode drivers on the end-user systems must be equal or newer to the version of the user-mode APIs. Thus, when the user-mode API is installed or updated on end-user systems, it is required to ensure that the kernel-mode drivers already present in the system are updated to match the version of the installed user-mode API.

The user mode API comes in two pieces, both of which must be deployed with the application:

  • A Python module named cbfsfilter.py.
  • A native library (unmanaged), named pycbfsfilter20.dll, available for both 32-bit (x86) and 64-bit (x64) processor architectures.

Both of these are included in the product's Python package, <install_dir>\cbfsfilter-20.0.xxxx.tar.gz, which should be installed using pip:

cd C:\path\to\install_dir
python -m pip install cbfsfilter-20.0.xxxx.tar.gz

Once the product's Python package has been installed, the module can be imported and used: from cbfsfilter import *. Nothing else is required to deploy the application.

As an alternative to installing the module using pip, you can utilize the built-in setuptools module to package the module for deployment or install it to the machine.

python setup.py build --build-lib=<app_dir>
The above setup command packages the module and native library for deployment. A folder is created in the app_dir directory with the module and the native library packaged inside.

Remember to deploy the drivers too, as they are an integral part of CBFS Filter.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 8317]