PyTPP Documentation

The intended audience is anyone having access to the Venafi Trust Protection Platform (TPP) WebSDK API that is seeking an advanced Python programmable interface to TPP.

PyTPP is a programmable interface that leverages the TPP WebSDK. It has layers: the API layer and the Features layer. The API layer provides serialization and deserialization for using the WebSDK API while the Features layer serves as an abstraction of the API layer. This allows the programmer to use either the API layer or the Features layer to accomplish the same task; the Features layer just simplifies everything.

Requirements

Python >= 3.8
Access to an OAuth API Application Integration. You can create a customized API Application Integration in Aperture for PyTPP, which is documented here. Here is an example JSON that can be uploaded when creating a new API Application Integration in Aperture:

{
    "id"         : "pytpp",
    "name"       : "Venafi PyTPP SDK",
    "vendor"     : "Venafi, Inc.",
    "description": "Application Integration for PyTPP, a Python interface to TPP.",
    "scope"      : "certificate:approve,delete,discover,manage,read,revoke;ssh:approve,delete,discover,manage,read;codesign:delete,manage,read;configuration:delete,manage,read;restricted:delete,manage,read;security:delete,manage,read;statistics:read;agent:delete,read"
}

Note

Most PyTPP features require the configuration:manage scope to be included in the OAuth Application definition.

Installation

Install using pip install pytpp.

Note

PyTPP is not versioned with TPP. In fact, PyTPP is meant to be compatible with the latest released version of TPP. Versioning has been baked into the PyTPP Features layer (which allows a feature to know how to accomplish its task), but not the API layer. It is the responsibility of the programmer to know what APIs are compatible with the version of TPP they are working with.