{"id":19391087,"url":"https://github.com/spiffe/spire-plugin-sdk","last_synced_at":"2025-04-06T06:07:16.303Z","repository":{"id":40545276,"uuid":"350468369","full_name":"spiffe/spire-plugin-sdk","owner":"spiffe","description":"SPIRE Plugin service definitions and scaffolding ","archived":false,"fork":false,"pushed_at":"2025-03-21T19:48:35.000Z","size":310,"stargazers_count":18,"open_issues_count":3,"forks_count":22,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-29T08:33:43.775Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spiffe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-22T19:42:35.000Z","updated_at":"2025-03-18T19:51:51.000Z","dependencies_parsed_at":"2024-06-18T17:03:46.163Z","dependency_job_id":"788ae10d-f164-4eb1-b2d5-2c2c8d8b1125","html_url":"https://github.com/spiffe/spire-plugin-sdk","commit_stats":null,"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spiffe%2Fspire-plugin-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spiffe%2Fspire-plugin-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spiffe%2Fspire-plugin-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spiffe%2Fspire-plugin-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spiffe","download_url":"https://codeload.github.com/spiffe/spire-plugin-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441049,"owners_count":20939239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T10:24:39.168Z","updated_at":"2025-04-06T06:07:16.283Z","avatar_url":"https://github.com/spiffe.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SPIRE Plugin SDK\n\nThis repository contains the service definitions, code generated stubs, and\ninfrastructure for running and testing [SPIRE](https://github.com/spiffe/spire) plugins.\n\n## Overview\n\nSPIRE supports a rich plugin system. Plugins can either be built in, or\nexternal, to SPIRE. External plugins are separate processes and use\n[go-plugin](https://github.com/hashicorp/go-plugin) under the covers.\n\nSPIRE communicates with plugins over gRPC. As such, the various interfaces are defined via gRPC service definitions.\n\nThere are three types of interfaces:\n\n| Type         | Description\n| ------------ | --------------------------------------------------------------|\n| Plugin       | The primary plugin interface. A plugin only implements only one plugin interface. |\n| Service      | An auxiliary service interface. These are generic facilities consumed by SPIRE. An example is the common [Config](proto/spire/service/common/config) service. A plugin implements zero or more service interfaces. |\n| Host Service | A service provided by SPIRE and optionally consumed by plugins. |\n\n## Plugins\n\n### Agent\n\n| Plugin | Versions | Description | Template    |\n| ------ | -------- | ----------- | ----------- |\n| KeyManager       | [v1](proto/spire/plugin/agent/keymanager/v1/keymanager.proto)                | Manages private keys and performs signing operations.  | [link](templates/agent/keymanager)         |\n| NodeAttestor     | [v1](proto/spire/plugin/agent/nodeattestor/v1/nodeattestor.proto)            | Performs the agent side of the node attestation flow.  | [link](templates/agent/nodeattestor)       |\n| SVIDStore        | [v1](proto/spire/plugin/agent/svidstore/v1/svidstore.proto)                  | Stores workload X509-SVIDs to arbitrary destinations.  | [link](templates/agent/svidstore)          |\n| WorkloadAttestor | [v1](proto/spire/plugin/agent/workloadattestor/v1/workloadattestor.proto)    | Attests workloads and provides selectors.              | [link](templates/agent/workloadattestor)   |\n\n### Server\n\n| Plugin | Versions  | Description | Template    |\n| ------ | --------  | ----------- | ----------- |\n| BundlePublisher | [v1](proto/spire/plugin/server/bundlepublisher/v1/bundlepublisher.proto) | Publishes a trust bundle to a store.               | [link](templates/server/bundlepublisher) |\n| CredentialComposer | [v1](proto/spire/plugin/server/credentialcomposer/v1/credentialcomposer.proto) | Allows customization of SVID and CA attributes.        | [link](templates/server/credentialcomposer) |\n| KeyManager         | [v1](proto/spire/plugin/server/keymanager/v1/keymanager.proto)                 | Manages private keys and performs signing operations.  | [link](templates/server/keymanager)         |\n| NodeAttestor       | [v1](proto/spire/plugin/server/nodeattestor/v1/nodeattestor.proto)             | Performs the server side of the node attestation flow. | [link](templates/server/nodeattestor)       |\n| Notifier           | [v1](proto/spire/plugin/server/notifier/v1/notifier.proto)                     | Notifies external systems of certain SPIRE events.     | [link](templates/server/notifier)           |\n| UpstreamAuthority  | [v1](proto/spire/plugin/server/upstreamauthority/v1/upstreamauthority.proto)   | Plugs SPIRE into an upstream PKI.                      | [link](templates/server/upstreamauthority)  |\n\n\n## Services\n\n### Common\n\n| Service | Versions | Description |\n| ------- | -------- | ----------- |\n| Config | [v1](proto/spire/service/common/config/v1/config.proto) | Used by SPIRE to configure the plugin. |\n\n\n## Host Services\n\n### Common\n\n| Host Service | Versions | Description |\n| ------------ | -------- | ----------- |\n| Metrics | [v1](proto/spire/hostservice/common/metrics/v1/metrics.proto) | Provides metrics facilities. |\n\n\n### Server\n\n| Host Service | Versions | Description |\n| ------------ | -------- | ----------- |\n| IdentityProvider | [v1](proto/spire/hostservice/server/identityprovider/v1/identityprovider.proto) | Provides an identity and bundle information. |\n| AgentStore       | [v1](proto/spire/hostservice/server/agentstore/v1/agentstore.proto)             | Provides information about attested agents.  |\n\n\n## Authoring Plugins\n\nFor guidance in authoring a plugin, see [AUTHORING](/docs/AUTHORING.md).\n\n## Migrating Pre-SDK Plugins\n\nTo migrate existing pre-SDK plugins, see [MIGRATING](/docs/MIGRATING.md).\n\n## Versioning\n\nThis repository is tagged along with SPIRE releases with the same name, even if\nthere are no changes to the APIs between SPIRE versions. This allows consumers\nto always pick a tag that matches up with their deployment. Even so, SPIRE\nmaintains API compatibility between SPIRE versions. SPIRE will clearly indicate\nin the [CHANGELOG](https://github.com/spiffe/spire/blob/main/CHANGELOG) when\nAPIs are deprecated and issue warnings at runtime when they are used well in\nadvance of any removal.\n\n## Contributing\n\nThis repository follows the same governance and contribution guidelines as the\n[SPIRE](https://github.com/spiffe/spire) project.\n\nFor specifics on getting started, see [CONTRIBUTING](/docs/CONTRIBUTING.md).\n\nPlease open [Issues](https://github.com/spiffe/spire/issues) to request features or file bugs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspiffe%2Fspire-plugin-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspiffe%2Fspire-plugin-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspiffe%2Fspire-plugin-sdk/lists"}