Skip to main content

Common Fate Provider Development Kit

Project description

Provider Development Kit

Common Fate Provider Development Kit for Python.

What is a provider?

A Provider is a Python service which provides a consistent API for managing fine-grain permissions.

Managing permissions in cloud providers, SaaS applications, and CI/CD platforms usually requires access to highly sensitive secrets, like administrative API tokens. The Provider framework allows for access to be granted and revoked to these platforms without requiring direct access to these tokens:

diagram of Provider framework

What does the Provider Development Kit do?

The Provider Development Kit (PDK) makes it easy to develop and deploy Providers.

class Provider(provider.Provider):
    api_url = provider.String()

@access.target()
class Target:
    ...

@access.grant()
def grant(p: Provider, subject: str, target: Target):
    # perform API calls here to grant access
    ...

@access.revoke()
def revoke(p: Provider, subject: str, target: Target):
    # perform API calls here to revoke access
    ...

The PDK handles configuration and packaging into a cloud-native function which can be executed by an application.

Supported runtimes

Currently the supported runtimes for Providers are as follows:

  • AWS Lambda

Provider Schemas

Each Provider has a strongly-typed schema. An example schema is shown below:

{
  "audit": {
    "resourceLoaders": {},
    "resources": {}
  },
  "config": {},
  "target": {
    "MyTarget": {
      "schema": {
        "first": {
          "description": "first var",
          "id": "first",
          "resourceName": null,
          "title": "First",
          "type": "string"
        }
      }
    }
  }
}

The schema is based on JSON Schema and allows applications using Providers to interpret the available resources and display the appropriate UI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

provider-0.11.0.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

provider-0.11.0-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file provider-0.11.0.tar.gz.

File metadata

  • Download URL: provider-0.11.0.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Linux/5.15.0-1035-azure

File hashes

Hashes for provider-0.11.0.tar.gz
Algorithm Hash digest
SHA256 20dd93e7781220f0f3ff749988613f112ef6eaf09382d8468a2cc741f90a74a9
MD5 466e0628c3789cd8043b1c6c8b40c7e7
BLAKE2b-256 925bf99c02bf91dcca41f704c72545dc44f5913bb178e1d2b88813c35a2abb9c

See more details on using hashes here.

File details

Details for the file provider-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: provider-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 33.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.9.16 Linux/5.15.0-1035-azure

File hashes

Hashes for provider-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 183c93918e643c4a1609c5106b53d15c9ef68a69934e98b6d663d22541d1e79d
MD5 570de492d67dae0c79be54a883669784
BLAKE2b-256 4a592f6d80da0d92497cb1c069635c3107785882d2d5a9b7f13a4641cd100a00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page