credentials

README

Credentials

back

To access Salesforce APIs, there needs to be authentication between the client and the org. go-sfdc uses OAuth 2.0 and this package provides the credentials needed to authenticate.

The user is able to use the Providers that are part of this package, or implement one of their own. This allows for extendability beyond what is currently supported.

Currently, this package supports grant type of password OAuth flow. The package may or may not be support other flows in the future.

Examples

The following are some example(s) of creating credentials to be used when opening a session.

Password

creds := credentials.PasswordCredentials{
	URL:          "https://login.salesforce.com",
	Username:     "my.user@name.com",
	Password:     "greatpassword",
	ClientID:     "asdfnapodfnavppe",
	ClientSecret: "12312573857105",
}

config := sfdc.Configuration{
	Credentials: credentials.NewPasswordCredentials(creds),
	Client:      salesforceHTTPClient,
	Version:     44,
}

JWT

// read the key file
privateKeyFile, err := os.Open("/path/to/server.key")
if err != nil {
    panic()
}
pemfileinfo, _ := privateKeyFile.Stat()
var size int64 = pemfileinfo.Size()
pembytes := make([]byte, size)
buffer := bufio.NewReader(privateKeyFile)
_, err = buffer.Read(pembytes)
pemData := []byte(pembytes)
privateKeyFile.Close() // close file
signKey, err := jwt.ParseRSAPrivateKeyFromPEM(pemData)

// prepare the credentials
jwtCreds := credentials.JwtCredentials{
    URL: "https://login.salesforce.com",
    ClientId: "glfeoeirjgouwehf",
    ClientUsername: "my.user@name.com",
    ClientKey: signKey,
}

config := sfdc.Configuration{
    Credentials: credentials.NewJWTCredentials(jwtCreds),
    Client:      &http.Client{},
    Version:     44,
}

Documentation

Index

• Constants
• type Credentials
  • func NewCredentials(provider Provider) (*Credentials, error)
  • func NewJWTCredentials(creds JwtCredentials) (*Credentials, error)
  • func NewPasswordCredentials(creds PasswordCredentials) (*Credentials, error)
  • func (creds *Credentials) Retrieve() (io.Reader, error)
  • func (creds *Credentials) URL() string
• type JwtCredentials
• type PasswordCredentials
• type Provider

Constants

const (
	JwtExpiration = 3 * time.Minute
)

Types

type Credentials

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

Credentials is the structure that contains all of the information for creating a session.

func NewCredentials

func NewCredentials(provider Provider) (*Credentials, error)

NewCredentials will create a credential with the custom provider.

func NewJWTCredentials

func NewJWTCredentials(creds JwtCredentials) (*Credentials, error)

NewJWTCredentials weill create a credntial with all required info about generating a JWT claims parameter

func NewPasswordCredentials

func NewPasswordCredentials(creds PasswordCredentials) (*Credentials, error)

NewPasswordCredentials will create a crendential with the password credentials.

func (*Credentials) Retrieve

func (creds *Credentials) Retrieve() (io.Reader, error)

Retrieve will return the reader for the HTTP request body.

func (*Credentials) URL

func (creds *Credentials) URL() string

URL is the URL base for the session endpoint.

type JwtCredentials

type JwtCredentials struct {
	URL            string
	ClientId       string // the client id as defined in the connected app in SalesForce
	ClientUsername string
	ClientKey      *rsa.PrivateKey // the client RSA key uploaded for authentication in the ConnectedApp
}

type PasswordCredentials

type PasswordCredentials struct {
	URL          string
	Username     string
	Password     string
	ClientID     string
	ClientSecret string
}

PasswordCredentials is a structure for the OAuth credentials that are needed to authenticate with a Salesforce org.

URL is the login URL used, examples would be https://test.salesforce.com or https://login.salesforce.com

Username is the Salesforce user name for logging into the org.

Password is the Salesforce password for the user.

ClientID is the client ID from the connected application.

ClientSecret is the client secret from the connected application.

type Provider

type Provider interface {
	Retrieve() (io.Reader, error)
	URL() string
}

Provider is the interface that is able to provide the session creator with all of the valid information.

Retrieve will return the reader for the HTTP request body.

URL is the URL base for the session endpoint.