gosip

README

Gosip - SharePoint authentication, HTTP client & fluent API wrapper for Go (Golang)

go mod tidy git tag v0.1.34 git push origin v0.1.34 go list -m github.com/pnocera/gosip@v0.1.34

Documentation

Overview

Package gosip is pure Go library for dealing with SharePoint unattended authentication and API consumption.

It supports a variety of different authentication strategies such as:

• SAML based with user credentials
• Add-in only permissions
• Azure AD auth strategies (via extensions https://go.spflow.com/auth/custom-auth)
• ADFS user credentials
• NTLM/NTLM v2 windows auth
• Auth to SharePoint behind a reverse proxy (TMG, WAP)
• Form-based authentication (FBA)
• Web login/On-Demand auth (via extension https://go.spflow.com/auth/custom-auth/on-demand)

Amongst supported platform versions are:

• SharePoint Online (SPO)
• On-Premise: 2019, 2016, and 2013

Index

• func GetDigest(context context.Context, client *SPClient) (string, error)
• type AuthCnfg
• type HookEvent
• type HookHandlers
• type SPClient
  • func (c *SPClient) Execute(req *http.Request) (*http.Response, error)

Functions

func GetDigest

func GetDigest(context context.Context, client *SPClient) (string, error)

GetDigest retrieves and caches SharePoint API X-RequestDigest value

Types

type AuthCnfg

type AuthCnfg interface {
	// GetAuth Authentication initializer (token/cookie/header, expiration, error)
	// to support capability for exposing tokens for external tools
	// e.g. as of this sample project https://github.com/koltyakov/spvault
	GetAuth() (string, int64, error)

	// SetAuth Authentication middleware fabric
	// applies round tripper or enriches requests with authentication and metadata
	SetAuth(req *http.Request, client *SPClient) error

	ParseConfig(jsonConf []byte) error  // Parses credentials from a provided JSON byte array content
	ReadConfig(configPath string) error // Reads credentials from storage

	GetSiteURL() string  // SiteURL getter method
	GetStrategy() string // Strategy code getter

}

AuthCnfg is an abstract auth config interface, allows different authentications strategies' dependency injection

type HookEvent

type HookEvent struct {
	Request    *http.Request
	StartedAt  time.Time
	StatusCode int
	Error      error
}

HookEvent hook event parameters struct

type HookHandlers

type HookHandlers struct {
	OnError    func(event *HookEvent) // when error appeared
	OnRetry    func(event *HookEvent) // before retry request
	OnRequest  func(event *HookEvent) // before request is sent
	OnResponse func(event *HookEvent) // after response is received
}

HookHandlers struct to configure events handlers

type SPClient

type SPClient struct {
	http.Client
	AuthCnfg   AuthCnfg // authentication configuration interface
	ConfigPath string   // private.json location path, optional when AuthCnfg is provided with creds explicitly

	RetryPolicies map[int]int   // allows redefining error state requests retry policies
	Hooks         *HookHandlers // hook handlers definition
}

SPClient : SharePoint HTTP client struct

func (*SPClient) Execute

func (c *SPClient) Execute(req *http.Request) (*http.Response, error)

Execute : SharePoint HTTP client is a wrapper for standard http.Client' `Do` method, injects authorization tokens, etc.