Categorygithub.com/cloudfoundry-community/go-credhub
modulepackage
0.9.1
Repository: https://github.com/cloudfoundry-community/go-credhub.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
1
Files
942 SLOC

# README

go-credhub Build Status GoDoc Report card Coverage Status

Overview

go-credhub is a client library for the Credhub API.

Usage

go get -u github.com/cloudfoundry-community/go-credhub

Experimental

  • For the foreseeable future, releases will be in the v0.x.y range
  • You should expect breaking changes until v1.x.y releases occur
  • Notifications of breaking changes will be made via release notes associated with each tag
  • This library is compatible both with dep and go 1.11 modules

Contributing

Pull requests welcome.

# Functions

CertificateValue will remarshal a credential so that its Value is a CertificateValueType.
New creates a new Credhub client.
NewCFAppAuthClient creates a CFAppAuthClient Example Usage: client := NewCFAppAuthClient(http.DefaultClient()) */.
NewUAAAuthClient creates a UAAAuthClient.
RSAValue will remarshal a credential so that its Value is a RSAValueType.
SSHValue will remarshal a credential so that its Value is a SSHValueType.
UAAEndpoint will get the info about the UAA server associated with the specified Credhub.
UserValue will remarshal a credential so that its Value is a UserValueType.

# Constants

Certificate - A private key, associated certificate, and CA.
Converge will only overwrite an existing credential if the parameters have changed.
Delete operation allows the actor to delete credentials.
JSON - An arbitrary block of JSON.
NoOverwrite will not overwrite an existing credential on Set or Generate.
Overwrite will overwrite an existing credential on Set or Generate.
Password - A password that can be (re-)generated.
Read operation allows the actor to fetch and view credentials.
ReadACL operation allows the actor to view all permissions on a given credential.
RSA - A public/private key pair.
SSH - An SSH private key, public key (in OpenSSH format), and public key fingerprint.
User - A username, password, and password hash.
Value - A generic value.
Write operation allows the actor to create, update, and generate credentials.
WriteACL operation allows the actor to create and delete permissions on a given credential.

# Structs

CertificateValueType is what a certificate type credential will have.
CFAppAuthClient wraps an HTTPClient and handles mTLS authentication.
Client interacts with the Credhub API.
Credential is the base type that the credential-based methods of Client will return.
Permission represents the operations an actor is allowed to perform on a credential.
RSAValueType is what a rsa type credential will have.
SSHValueType is what a ssh type credential will have.
UAAAuthClient is a thin wrapper around an http.Client that handles authenticating and renewing tokens provided via UAA.
UserValueType is what a user type credential will have.

# Interfaces

No description provided by the author

# Type aliases

CredentialType is the list of valid types of credentials Credhub supports.
Operation is the list of valid operations.
OverwriteMode is the list of valid "mode" arguments.