credentials

package

v0.0.0-...-3e6d8ed Latest Latest Go to latest Published: Jan 14, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudflare/cloudflared

Links

Documentation ¶

Index ¶

Constants
func FindDefaultOriginCertPath() string
func FindOriginCert(originCertPath string, log *zerolog.Logger) (string, error)
type OriginCert
- func DecodeOriginCert(blocks []byte) (*OriginCert, error)
- func (cert *OriginCert) EncodeOriginCert() ([]byte, error)
- func (oc *OriginCert) UnmarshalJSON(data []byte) error
type User
- func Read(originCertPath string, log *zerolog.Logger) (*User, error)

Constants ¶

View Source

const (
	FedEndpoint       = "fed"
	FedRampBaseApiURL = "https://api.fed.cloudflare.com/client/v4"
	FedRampHostname   = "management.fed.argotunnel.com"
)

View Source

const (
	DefaultCredentialFile = "cert.pem"
)

Variables ¶

This section is empty.

Functions ¶

func FindDefaultOriginCertPath ¶

func FindDefaultOriginCertPath() string

FindDefaultOriginCertPath returns the first path that contains a cert.pem file. If none of the DefaultConfigSearchDirectories contains a cert.pem file, return empty string

func FindOriginCert ¶

func FindOriginCert(originCertPath string, log *zerolog.Logger) (string, error)

FindOriginCert will check to make sure that the certificate exists at the specified file path.

Types ¶

type OriginCert ¶

type OriginCert struct {
	ZoneID    string `json:"zoneID"`
	AccountID string `json:"accountID"`
	APIToken  string `json:"apiToken"`
	Endpoint  string `json:"endpoint,omitempty"`
}

func DecodeOriginCert ¶

func DecodeOriginCert(blocks []byte) (*OriginCert, error)

func (*OriginCert) EncodeOriginCert ¶

func (cert *OriginCert) EncodeOriginCert() ([]byte, error)

func (*OriginCert) UnmarshalJSON ¶

func (oc *OriginCert) UnmarshalJSON(data []byte) error

type User ¶

type User struct {
	// contains filtered or unexported fields
}

func Read ¶

func Read(originCertPath string, log *zerolog.Logger) (*User, error)

Read will load and read the origin cert.pem to load the user credentials

func (User) APIToken ¶

func (c User) APIToken() string

func (User) AccountID ¶

func (c User) AccountID() string

func (User) CertPath ¶

func (c User) CertPath() string

func (*User) Client ¶

func (c *User) Client(apiURL string, userAgent string, log *zerolog.Logger) (cfapi.Client, error)

Client uses the user credentials to create a Cloudflare API client

func (User) Endpoint ¶

func (c User) Endpoint() string

func (User) IsFEDEndpoint ¶

func (c User) IsFEDEndpoint() bool

func (User) ZoneID ¶

func (c User) ZoneID() string

Source Files ¶

View all Source files

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