Pinniped is the easy, secure way to log in to your Kubernetes clusters.
Go to file
Monis Khan 942c55cf51
cli: prevent browser output from breaking ExecCredential output
This change updates the pinniped CLI entrypoint to prevent browser
processes that we spawn from polluting our std out stream.

For example, chrome will print the following message to std out:

Opening in existing browser session.

Which leads to the following incomprehensible error message from
kubectl:

Unable to connect to the server: getting credentials:
decoding stdout: couldn't get version/kind; json parse error:
json: cannot unmarshal string into Go value of type struct
{ APIVersion string "json:\"apiVersion,omitempty\"";
  Kind string "json:\"kind,omitempty\"" }

This would only occur on the initial login when we opened the
browser.  Since credentials would be cached afterwards, kubectl
would work as expected for future invocations as no browser was
opened.

I could not think of a good way to actually test this change.  There
is a clear gap in our integration tests - we never actually launch a
browser in the exact same way a user does - we instead open a chrome
driver at the login URL as a subprocess of the integration test
binary and not the pinniped CLI.  Thus even if the chrome driver was
writing to std out, we would not notice any issues.

It is also unclear if there is a good way to prevent future related
bugs since std out is global to the process.

Signed-off-by: Monis Khan <mok@vmware.com>
2021-08-16 09:13:57 -04:00
.github Ignore test coverage for local-user-authenticator. 2021-03-15 10:43:17 -05:00
apis Fix typo in generated API docs (s/mode/type/). 2021-07-09 11:28:02 -05:00
cmd cli: prevent browser output from breaking ExecCredential output 2021-08-16 09:13:57 -04:00
deploy Switch to a slimmer distroless base image. 2021-08-09 15:05:13 -04:00
generated Fix typo in generated API docs (s/mode/type/). 2021-07-09 11:28:02 -05:00
hack Upgrade github.com/ory/fosite to v0.40.2. 2021-05-28 12:53:37 -05:00
internal impersonator: update tests for new Impersonate-Uid code 2021-08-09 19:16:54 -04:00
pkg Fix broken TTY after manual auth code prompt. 2021-07-30 12:45:44 -05:00
public added search functionality to docs on Pinniped.dev 2021-04-09 10:58:39 -05:00
site Bump latest version on website. 2021-08-03 09:21:54 -05:00
test impersonation proxy: assert nested UID impersonation is disallowed 2021-08-10 00:03:33 -04:00
.dockerignore dockerignore gets same contents as gitignore 2021-07-26 11:28:25 -07:00
.gitattributes Add .gitattributes as a hint to the GitHub diff viewer. 2020-09-15 11:44:23 -05:00
.gitignore dockerignore gets same contents as gitignore 2021-07-26 11:28:25 -07:00
.golangci.yaml Don't lint generated code. 2021-02-16 13:18:18 -06:00
.pre-commit-config.yaml Rename dex namespace, add new ytt value to deploy/tools, and remove Tilt 2021-04-05 15:01:49 -07:00
ADOPTERS.md Add OK a.m.b.a. to adopters.md file 2021-04-14 18:38:11 -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 Fix my fix 🤦🏻 . 2021-06-02 11:06:03 -05:00
Dockerfile Bump to Go 1.16.7 and Kube v0.22.0 2021-08-09 15:32:13 -04:00
go.mod remove google.golang.org/grpc pin 2021-08-09 19:16:14 -04:00
go.sum remove google.golang.org/grpc pin 2021-08-09 19:16:14 -04:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
MAINTAINERS.md Merge pull request #731 from microwavables/main 2021-07-20 15:37:04 -07:00
README.md Fix a broken docs link in our README. 2021-04-26 13:48:17 -06:00
ROADMAP.md Update ROADMAP.md 2021-08-12 11:08:27 -04:00
SCOPE.md Move scope doc out of website to SCOPE.md. 2021-02-23 11:11:07 -06:00
SECURITY.md SECURITY.md: follow established pattern 2021-02-09 09:08:19 -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.

Getting started with Pinniped

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

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.

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 or reach out in Kubernetes Slack Workspace within the #pinniped channel.

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.