go.pinniped.dev

module

v0.12.1 Latest Latest Go to latest Published: Feb 9, 2022 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vmware-tanzu/pinniped

Links

Open Source Insights

README ¶

Overview

Pinniped provides identity services to Kubernetes.

Easily plug in external identity providers into Kubernetes clusters while offering a simple install and configuration experience. Leverage first class integration with Kubernetes and kubectl command-line.
Give users a consistent, unified login experience across all your clusters, including on-premises and managed cloud environments.
Securely integrate with an enterprise IDP using standard protocols or use secure, externally managed identities instead of relying on simple, shared credentials.

To learn more, please visit the Pinniped project's website, https://pinniped.dev.

Getting started with Pinniped

Care to kick the tires? It's easy to install and try Pinniped.

Discussion

Got a question, comment, or idea? Please don't hesitate to reach out via GitHub Discussions, GitHub Issues, or in the Kubernetes Slack Workspace within the #pinniped channel.

Contributions

Want to get involved? Contributions are welcome.

Please see the contributing guide for more information about reporting bugs, requesting features, building and testing the code, submitting PRs, and other contributor topics.

Community meetings

Pinniped is better because of our contributors and maintainers. It is because of you that we can bring great software to the community. Please join us during our online community meetings, occurring every first and third Thursday of the month at 9 AM PT / 12 PM PT. Use this Zoom Link to attend and add any agenda items you wish to discuss to the notes document. Join our Google Group to receive invites to this meeting.

If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled.

Adopters

Some organizations and products using Pinniped are featured in ADOPTERS.md. Add your own organization or product here.

Reporting security vulnerabilities

Please follow the procedure described in SECURITY.md.

License

Pinniped is open source and licensed under Apache License Version 2.0. See LICENSE.

Directories ¶

Path	Synopsis
cmd
pinniped
pinniped-concierge-kube-cert-agent Package main is the combined entrypoint for the Pinniped "kube-cert-agent" component.	Package main is the combined entrypoint for the Pinniped "kube-cert-agent" component.
pinniped-server Package main is the combined entrypoint for all Pinniped server components.	Package main is the combined entrypoint for all Pinniped server components.
pinniped/cmd
generated
latest/apis/concierge/authentication/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped concierge authentication API.	Package v1alpha1 is the v1alpha1 version of the Pinniped concierge authentication API.
latest/apis/concierge/config/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration API.	Package v1alpha1 is the v1alpha1 version of the Pinniped concierge configuration API.
latest/apis/concierge/identity Package identity is the internal version of the Pinniped identity API.	Package identity is the internal version of the Pinniped identity API.
latest/apis/concierge/identity/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped identity API.	Package v1alpha1 is the v1alpha1 version of the Pinniped identity API.
latest/apis/concierge/identity/validation
latest/apis/concierge/login Package login is the internal version of the Pinniped login API.	Package login is the internal version of the Pinniped login API.
latest/apis/concierge/login/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped login API.	Package v1alpha1 is the v1alpha1 version of the Pinniped login API.
latest/apis/supervisor/config/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped supervisor configuration API.	Package v1alpha1 is the v1alpha1 version of the Pinniped supervisor configuration API.
latest/apis/supervisor/idp/v1alpha1 Package v1alpha1 is the v1alpha1 version of the Pinniped supervisor identity provider (IDP) API.	Package v1alpha1 is the v1alpha1 version of the Pinniped supervisor identity provider (IDP) API.
latest/apis/supervisor/idpdiscovery/v1alpha1
latest/apis/supervisor/oidc
latest/client/concierge/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
latest/client/concierge/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
latest/client/concierge/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
latest/client/concierge/clientset/versioned/typed/authentication/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/concierge/clientset/versioned/typed/authentication/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/concierge/clientset/versioned/typed/config/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/concierge/clientset/versioned/typed/config/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/concierge/clientset/versioned/typed/identity/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/concierge/clientset/versioned/typed/identity/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/concierge/clientset/versioned/typed/login/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/concierge/clientset/versioned/typed/login/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/concierge/informers/externalversions
latest/client/concierge/informers/externalversions/authentication
latest/client/concierge/informers/externalversions/authentication/v1alpha1
latest/client/concierge/informers/externalversions/config
latest/client/concierge/informers/externalversions/config/v1alpha1
latest/client/concierge/informers/externalversions/internalinterfaces
latest/client/concierge/listers/authentication/v1alpha1
latest/client/concierge/listers/config/v1alpha1
latest/client/supervisor/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
latest/client/supervisor/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
latest/client/supervisor/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
latest/client/supervisor/clientset/versioned/typed/config/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/supervisor/clientset/versioned/typed/config/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/supervisor/clientset/versioned/typed/idp/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
latest/client/supervisor/clientset/versioned/typed/idp/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
latest/client/supervisor/informers/externalversions
latest/client/supervisor/informers/externalversions/config
latest/client/supervisor/informers/externalversions/config/v1alpha1
latest/client/supervisor/informers/externalversions/idp
latest/client/supervisor/informers/externalversions/idp/v1alpha1
latest/client/supervisor/informers/externalversions/internalinterfaces
latest/client/supervisor/listers/config/v1alpha1
latest/client/supervisor/listers/idp/v1alpha1
1.17/apis Module
1.17/client Module
1.18/apis Module
1.18/client Module
1.19/apis Module
1.19/client Module
1.20/apis Module
1.20/client Module
1.21/apis Module
1.21/client Module
1.22/apis Module
1.22/client Module
1.23/apis Module
1.23/client Module
1.24/apis Module
1.24/client Module
1.25/apis Module
1.25/client Module
1.26/apis Module
1.26/client Module
1.27/apis Module
1.27/client Module
1.28/apis Module
1.28/client Module
1.29/apis Module
1.29/client Module
internal
apiserviceref
authenticators Package authenticators contains authenticator interfaces.	Package authenticators contains authenticator interfaces.
certauthority Package certauthority implements a simple x509 certificate authority suitable for use in an aggregated API service.	Package certauthority implements a simple x509 certificate authority suitable for use in an aggregated API service.
certauthority/dynamiccertauthority Package dynamiccertauthority implements a x509 certificate authority capable of issuing certificates from a dynamically updating CA keypair.	Package dynamiccertauthority implements a x509 certificate authority capable of issuing certificates from a dynamically updating CA keypair.
clusterhost
concierge/apiserver
concierge/impersonator Package impersonator implements an HTTP server that reverse proxies all requests to the Kubernetes API server with impersonation headers set to match the calling user.	Package impersonator implements an HTTP server that reverse proxies all requests to the Kubernetes API server with impersonation headers set to match the calling user.
concierge/scheme Package scheme contains code to construct a proper runtime.Scheme for the Concierge aggregated API.	Package scheme contains code to construct a proper runtime.Scheme for the Concierge aggregated API.
concierge/server Package server is the command line entry point for pinniped-concierge.	Package server is the command line entry point for pinniped-concierge.
config/concierge Package concierge contains functionality to load/store Config's from/to some source.	Package concierge contains functionality to load/store Config's from/to some source.
config/supervisor Package supervisor contains functionality to load/store Config's from/to some source.	Package supervisor contains functionality to load/store Config's from/to some source.
constable
controller
controller/apicerts Package apicerts contains controllers that work together to provide rotating API certs.	Package apicerts contains controllers that work together to provide rotating API certs.
controller/authenticator Package authenticator contains helper code for dealing with *Authenticator CRDs.	Package authenticator contains helper code for dealing with *Authenticator CRDs.
controller/authenticator/authncache Package authncache implements a cache of active authenticators.	Package authncache implements a cache of active authenticators.
controller/authenticator/cachecleaner Package cachecleaner implements a controller for garbage collecting authenticators from an authenticator cache.	Package cachecleaner implements a controller for garbage collecting authenticators from an authenticator cache.
controller/authenticator/jwtcachefiller Package jwtcachefiller implements a controller for filling an authncache.Cache with each added/updated JWTAuthenticator.	Package jwtcachefiller implements a controller for filling an authncache.Cache with each added/updated JWTAuthenticator.
controller/authenticator/webhookcachefiller Package webhookcachefiller implements a controller for filling an authncache.Cache with each added/updated WebhookAuthenticator.	Package webhookcachefiller implements a controller for filling an authncache.Cache with each added/updated WebhookAuthenticator.
controller/conditionsutil
controller/impersonatorconfig
controller/issuerconfig Package issuerconfig contains helpers for updating CredentialIssuer status entries.	Package issuerconfig contains helpers for updating CredentialIssuer status entries.
controller/kubecertagent Package kubecertagent provides controllers that ensure a pod (the kube-cert-agent), is co-located with the Kubernetes controller manager so that Pinniped can access its signing keys.	Package kubecertagent provides controllers that ensure a pod (the kube-cert-agent), is co-located with the Kubernetes controller manager so that Pinniped can access its signing keys.
controller/kubecertagent/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
controller/supervisorconfig
controller/supervisorconfig/activedirectoryupstreamwatcher Package activedirectoryupstreamwatcher implements a controller which watches ActiveDirectoryIdentityProviders.	Package activedirectoryupstreamwatcher implements a controller which watches ActiveDirectoryIdentityProviders.
controller/supervisorconfig/generator Package secretgenerator provides a supervisorSecretsController that can ensure existence of a generated secret.	Package secretgenerator provides a supervisorSecretsController that can ensure existence of a generated secret.
controller/supervisorconfig/ldapupstreamwatcher Package ldapupstreamwatcher implements a controller which watches LDAPIdentityProviders.	Package ldapupstreamwatcher implements a controller which watches LDAPIdentityProviders.
controller/supervisorconfig/oidcupstreamwatcher Package oidcupstreamwatcher implements a controller which watches OIDCIdentityProviders.	Package oidcupstreamwatcher implements a controller which watches OIDCIdentityProviders.
controller/supervisorconfig/upstreamwatchers
controller/supervisorstorage
controllerinit
controllerlib
controllerlib/test/integration/examplecontroller/api
controllerlib/test/integration/examplecontroller/controller
controllerlib/test/integration/examplecontroller/starter
controllermanager Package controllermanager provides an entrypoint into running all of the controllers that run as a part of Pinniped.	Package controllermanager provides an entrypoint into running all of the controllers that run as a part of Pinniped.
crud
deploymentref
downward Package downward implements a client interface for interacting with Kubernetes "downwardAPI" volumes.	Package downward implements a client interface for interacting with Kubernetes "downwardAPI" volumes.
dynamiccert Package dynamiccert provides a simple way of communicating a dynamically updating PEM-encoded certificate and key.	Package dynamiccert provides a simple way of communicating a dynamically updating PEM-encoded certificate and key.
endpointaddr Package endpointaddr implements parsing and validation of "<host>[:<port>]" strings for Pinniped APIs.	Package endpointaddr implements parsing and validation of "<host>[:<port>]" strings for Pinniped APIs.
execcredcache Package execcredcache implements a cache for Kubernetes ExecCredential data.	Package execcredcache implements a cache for Kubernetes ExecCredential data.
fositestorage
fositestorage/accesstoken
fositestorage/authorizationcode
fositestorage/openidconnect
fositestorage/pkce
fositestorage/refreshtoken
fositestoragei
groupsuffix
here
httputil/httperr Package httperr contains some helpers for nicer error handling in http.Handler implementations.	Package httperr contains some helpers for nicer error handling in http.Handler implementations.
httputil/roundtripper
httputil/securityheader Package securityheader implements an HTTP middleware for setting security-related response headers.	Package securityheader implements an HTTP middleware for setting security-related response headers.
issuer
kubeclient
leaderelection
localuserauthenticator Package localuserauthenticator provides a authentication webhook program.	Package localuserauthenticator provides a authentication webhook program.
mocks/credentialrequestmocks Package credentialrequestmocks is a generated GoMock package.	Package credentialrequestmocks is a generated GoMock package.
mocks/issuermocks Package issuermocks is a generated GoMock package.	Package issuermocks is a generated GoMock package.
mocks/mockkeyset Package mockkeyset is a generated GoMock package.	Package mockkeyset is a generated GoMock package.
mocks/mockldapconn Package mockldapconn is a generated GoMock package.	Package mockldapconn is a generated GoMock package.
mocks/mocksecrethelper Package mocksecrethelper is a generated GoMock package.	Package mocksecrethelper is a generated GoMock package.
mocks/mocktokenauthenticator Package mocktokenauthenticator is a generated GoMock package.	Package mocktokenauthenticator is a generated GoMock package.
mocks/mocktokenauthenticatorcloser Package mocktokenauthenticatorcloser is a generated GoMock package.	Package mocktokenauthenticatorcloser is a generated GoMock package.
mocks/mockupstreamoidcidentityprovider Package mockupstreamoidcidentityprovider is a generated GoMock package.	Package mockupstreamoidcidentityprovider is a generated GoMock package.
oidc Package oidc contains common OIDC functionality needed by Pinniped.	Package oidc contains common OIDC functionality needed by Pinniped.
oidc/auth Package auth provides a handler for the OIDC authorization endpoint.	Package auth provides a handler for the OIDC authorization endpoint.
oidc/callback Package callback provides a handler for the OIDC callback endpoint.	Package callback provides a handler for the OIDC callback endpoint.
oidc/clientregistry Package clientregistry defines Pinniped's OAuth2/OIDC clients.	Package clientregistry defines Pinniped's OAuth2/OIDC clients.
oidc/csrftoken
oidc/discovery Package discovery provides a handler for the OIDC discovery endpoint.	Package discovery provides a handler for the OIDC discovery endpoint.
oidc/downstreamsession Package downstreamsession provides some shared helpers for creating downstream OIDC sessions.	Package downstreamsession provides some shared helpers for creating downstream OIDC sessions.
oidc/dynamiccodec Package dynamiccodec provides a type that can encode information using a just-in-time signing and (optionally) encryption secret.	Package dynamiccodec provides a type that can encode information using a just-in-time signing and (optionally) encryption secret.
oidc/idpdiscovery Package idpdiscovery provides a handler for the upstream IDP discovery endpoint.	Package idpdiscovery provides a handler for the upstream IDP discovery endpoint.
oidc/jwks Package discovery provides a handler for the OIDC discovery endpoint.	Package discovery provides a handler for the OIDC discovery endpoint.
oidc/provider
oidc/provider/formposthtml Package formposthtml defines HTML templates used by the Supervisor.	Package formposthtml defines HTML templates used by the Supervisor.
oidc/provider/manager
oidc/token Package token provides a handler for the OIDC token endpoint.	Package token provides a handler for the OIDC token endpoint.
ownerref
plog Package plog implements a thin layer over klog to help enforce pinniped's logging convention.	Package plog implements a thin layer over klog to help enforce pinniped's logging convention.
registry/credentialrequest Package credentialrequest provides REST functionality for the CredentialRequest resource.	Package credentialrequest provides REST functionality for the CredentialRequest resource.
registry/whoamirequest
secret
supervisor/server Package server defines the entrypoint for the Pinniped Supervisor server.	Package server defines the entrypoint for the Pinniped Supervisor server.
testutil Package testutil contains shared test utilities for the Pinniped project.	Package testutil contains shared test utilities for the Pinniped project.
testutil/fakekubeapi Package fakekubeapi contains a very simple httptest.Server that can be used to stand in for a real Kube API server in tests.	Package fakekubeapi contains a very simple httptest.Server that can be used to stand in for a real Kube API server in tests.
testutil/oidctestutil
testutil/testlogger Package testlogger implements a logr.Logger suitable for writing test assertions.	Package testlogger implements a logr.Logger suitable for writing test assertions.
upstreamldap Package upstreamldap implements an abstraction of upstream LDAP IDP interactions.	Package upstreamldap implements an abstraction of upstream LDAP IDP interactions.
upstreamoidc Package upstreamoidc implements an abstraction of upstream OIDC provider interactions.	Package upstreamoidc implements an abstraction of upstream OIDC provider interactions.
valuelesscontext
pkg
conciergeclient Package conciergeclient provides login helpers for the Pinniped concierge.	Package conciergeclient provides login helpers for the Pinniped concierge.
oidcclient Package oidcclient implements a CLI OIDC login flow.	Package oidcclient implements a CLI OIDC login flow.
oidcclient/filesession Package cachefile implements the file format for session caches.	Package cachefile implements the file format for session caches.
oidcclient/nonce Package nonce implements	Package nonce implements
oidcclient/oidctypes Package oidctypes provides core data types for OIDC token structures.	Package oidctypes provides core data types for OIDC token structures.
oidcclient/pkce
oidcclient/state
test
testlib
testlib/browsertest Package browsertest provides integration test helpers for our browser-based tests.	Package browsertest provides integration test helpers for our browser-based tests.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL