Pinniped is the easy, secure way to log in to your Kubernetes clusters.
Go to file
Ryan Richard f46de56b95 Fix broken upstream OIDC discovery timeout added in previous commit
After noticing that the upstream OIDC discovery calls can hang
indefinitely, I had tried to impose a one minute timeout on them
by giving them a timeout context. However, I hadn't noticed that the
context also gets passed into the JWKS fetching object, which gets
added to our cache and used later. Therefore the timeout context
was added to the cache and timed out while sitting in the cache,
causing later JWKS fetchers to fail.

This commit is trying again to impose a reasonable timeout on these
discovery and JWKS calls, but this time by using http.Client's Timeout
field, which is documented to be a timeout for *each* request/response
cycle, so hopefully this is a more appropriate way to impose a timeout
for this use case. The http.Client instance ends up in the cache on
the JWKS fetcher object, so the timeout should apply to each JWKS
request as well.

Requests that can hang forever are effectively a server-side resource
leak, which could theoretically be taken advantage of in a denial of
service attempt, so it would be nice to avoid having them.
2021-07-08 09:48:03 -07:00
.github Get rid of WIP workflow 2020-10-27 18:39:19 -04:00
apis Rename off of main 2020-12-16 14:27:09 -08:00
cmd Ignore lint error 2021-01-08 14:13:04 -08:00
deploy Add https_proxy and no_proxy settings for the Supervisor 2021-07-07 16:19:23 -07:00
generated Revert changes to generated 1.20 go.mod. 2021-04-22 11:51:52 -05:00
hack Wire in new env vars for user info testing 2021-01-12 11:23:25 -05:00
internal Fix broken upstream OIDC discovery timeout added in previous commit 2021-07-08 09:48:03 -07:00
pkg Merge branch 'main' of github.com:vmware-tanzu/pinniped into kubernetes-1.20 2021-01-08 13:22:31 -08:00
site Fixing documentation to reference 1.20 generated docs 2021-01-08 15:21:23 -08:00
test Adjust "/bin/killall sleep" in new test to be less flaky in CI. 2021-04-22 14:51:55 -05:00
.gitattributes Add .gitattributes as a hint to the GitHub diff viewer. 2020-09-15 11:44:23 -05:00
.gitignore Add Tilt-based local dev workflow. 2020-10-05 16:34:33 -05:00
.golangci.yaml Linter allows range of years in copyright 2021-01-05 13:35:09 -08:00
.pre-commit-config.yaml Got pre-commit to check for correct copyright year 2021-01-05 15:53:14 -08:00
.pre-commit-hooks.yaml Copyright year precommit hook 2021-01-05 14:02:28 -08:00
ADOPTERS.md Update module/package names to match GitHub org switch. 2020-09-17 12:56:54 -05:00
CODE_OF_CONDUCT.md Rename the CoC and contributor guide to the names GitHub recognizes. 2020-10-02 15:53:48 -05:00
CONTRIBUTING.md CONTRIBUTING.md: add missing integration test dependencies 2020-12-17 13:59:23 -05:00
Dockerfile Upgrade Go from 1.15.11 to 1.15.12. 2021-05-25 16:45:12 -05:00
go.mod Upgrade Kubernetes library dependencies from v1.20.6 to v1.20.7. 2021-05-25 16:30:36 -05:00
go.sum Upgrade Kubernetes library dependencies from v1.20.6 to v1.20.7. 2021-05-25 16:30:36 -05:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
MAINTAINERS.md Add Margo and Mo as maintainers of Pinniped 2020-12-17 13:37:20 -05:00
README.md Fixing documentation to reference 1.20 generated docs 2021-01-08 15:21:23 -08:00
SECURITY.md Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -05:00

Pinniped Logo

Overview

Pinniped provides identity services to Kubernetes.

Pinniped allows cluster administrators to easily plug in external identity providers (IDPs) into Kubernetes clusters. This is achieved via a uniform install procedure across all types and origins of Kubernetes clusters, declarative configuration via Kubernetes APIs, enterprise-grade integrations with IDPs, and distribution-specific integration strategies.

Example Use Cases

  • Your team uses a large enterprise IDP, and has many clusters that they manage. Pinniped provides:
    • Seamless and robust integration with the IDP
    • Easy installation across clusters of any type and origin
    • A simplified login flow across all clusters
  • Your team shares a single cluster. Pinniped provides:
    • Simple configuration to integrate an IDP
    • Individual, revocable identities

Architecture

The Pinniped Supervisor component offers identity federation to enable a user to access multiple clusters with a single daily login to their external IDP. The Pinniped Supervisor supports various external IDP types.

The Pinniped Concierge component offers credential exchange to enable a user to exchange an external credential for a short-lived, cluster-specific credential. Pinniped supports various authentication methods and implements different integration strategies for various Kubernetes distributions to make authentication possible.

The Pinniped Concierge can be configured to hook into the Pinniped Supervisor's federated credentials, or it can authenticate users directly via external IDP credentials.

To learn more, see architecture.

Pinniped Architecture Sketch

Trying 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 the GitHub Discussions tab at the top of this page.

Contributions

Contributions are welcome. Before contributing, please see the contributing guide.

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.

Copyright 2020 the Pinniped contributors. All Rights Reserved.