gosip

⚡️ SharePoint SDK for Go

Programming language: Go

License: MIT License

Tags: Third-party APIs    

README

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

<!--suppress HtmlDeprecatedAttribute -->

Main features

• Unattended authentication using different strategies.
• Fluent API syntax for SharePoint object model.
• Simplified API consumption (REST, CSOM, SOAP).
• SharePoint-aware embedded features (retries, header presets, error handling).

Supported SharePoint versions

• SharePoint Online (SPO)
• On-Premises (2019/2016/2013)

Supported auth strategies

• SharePoint Online:

  • Azure Certificate (App Only) 🔗
  • Azure Username/Password 🔗
  • SAML based with user credentials
  • Add-In only permissions
  • ADFS user credentials (automatically detects in SAML strategy)
  • On-Demand auth 🔗
  • Azure AD Device flow 🔗

• SharePoint On-Premises 2019/2016/2013:

  • User credentials (NTLM)
  • ADFS user credentials (ADFS, WAP -> Basic/NTLM, WAP -> ADFS)
  • Behind a reverse proxy (Forefront TMG, WAP -> Basic/NTLM, WAP -> ADFS)
  • Form-based authentication (FBA)
  • On-Demand auth 🔗

Installation

go get github.com/koltyakov/gosip

Usage insights

1. Understand SharePoint environment type and authentication strategy.

Let's assume it's SharePoint Online and Add-In Only permissions. Then strategy "github.com/koltyakov/gosip/auth/addin" subpackage should be used.

package main

import (
    "github.com/koltyakov/gosip"
    "github.com/koltyakov/gosip/api"
    strategy "github.com/koltyakov/gosip/auth/addin"
)

2. Initiate an authentication object.

auth := &strategy.AuthCnfg{
    SiteURL:      os.Getenv("SPAUTH_SITEURL"),
    ClientID:     os.Getenv("SPAUTH_CLIENTID"),
    ClientSecret: os.Getenv("SPAUTH_CLIENTSECRET"),
}

AuthCnfg from different strategies contains different options relevant for a specified auth type.

The authentication options can be provided explicitly or can be read from a configuration file.

configPath := "./config/private.json"
auth := &strategy.AuthCnfg{}

err := auth.ReadConfig(configPath)
if err != nil {
    fmt.Printf("Unable to get config: %v\n", err)
    return
}

3. Bind auth client with Fluent API.

client := &gosip.SPClient{AuthCnfg: auth}

sp := api.NewSP(client)

res, err := sp.Web().Select("Title").Get()
if err != nil {
    fmt.Println(err)
}

fmt.Printf("%s\n", res.Data().Title)

Usage samples

Fluent API client

Fluent API gives a simple way of constructing API endpoint calls with IntelliSense and chainable syntax.

package main

import (
    "encoding/json"
    "fmt"
    "log"

    "github.com/koltyakov/gosip"
    "github.com/koltyakov/gosip/api"
    strategy "github.com/koltyakov/gosip/auth/addin"
)

func main() {
    // Getting auth params and client
    client, err := getAuthClient()
    if err != nil {
        log.Fatalln(err)
    }

    // Binding SharePoint API
    sp := api.NewSP(client)

    // Custom headers
    headers := map[string]string{
        "Accept": "application/json;odata=minimalmetadata",
        "Accept-Language": "de-DE,de;q=0.9",
    }
    config := &api.RequestConfig{Headers: headers}

    // Chainable request sample
    data, err := sp.Conf(config).Web().Lists().Select("Id,Title").Get()
    if err != nil {
        log.Fatalln(err)
    }

    // Response object unmarshalling (struct depends on OData mode and API method)
    res := &struct {
        Value []struct {
            ID    string `json:"Id"`
            Title string `json:"Title"`
        } `json:"value"`
    }{}

    if err := json.Unmarshal(data, &res); err != nil {
        log.Fatalf("unable to parse the response: %v", err)
    }

    for _, list := range res.Value {
        fmt.Printf("%+v\n", list)
    }

}

func getAuthClient() (*gosip.SPClient, error) {
    configPath := "./config/private.spo-addin.json"
    auth := &strategy.AuthCnfg{}
    if err := auth.ReadConfig(configPath); err != nil {
        return nil, fmt.Errorf("unable to get config: %v", err)
    }
    return &gosip.SPClient{AuthCnfg: auth}, nil
}

Generic HTTP client helper

Provides generic GET/POST helpers for REST operations, reducing the amount of http.NewRequest scaffolded code, can be used for custom or not covered with Fluent API endpoints.

package main

import (
    "fmt"
    "log"

    "github.com/koltyakov/gosip"
    "github.com/koltyakov/gosip/api"
    strategy "github.com/koltyakov/gosip/auth/ntlm"
)

func main() {
    configPath := "./config/private.ntlm.json"
    auth := &strategy.AuthCnfg{}

    if err := auth.ReadConfig(configPath); err != nil {
        log.Fatalf("unable to get config: %v\n", err)
    }

    sp := api.NewHTTPClient(&gosip.SPClient{AuthCnfg: auth})

    endpoint := auth.GetSiteURL() + "/_api/web?$select=Title"

    data, err := sp.Get(endpoint, nil)
    if err != nil {
        log.Fatalf("%v\n", err)
    }

    // sp.Post(endpoint, body, nil) // generic POST
    // sp.Delete(endpoint, nil) // generic DELETE helper crafts "X-Http-Method"="DELETE" header
    // sp.Update(endpoint, nil) // generic UPDATE helper crafts "X-Http-Method"="MERGE" header
    // sp.ProcessQuery(endpoint, body) // CSOM helper (client.svc/ProcessQuery)

    fmt.Printf("response: %s\n", data)
}

Low-level HTTP client usage

Low-lever SharePoint-aware HTTP client from github.com/koltyakov/gosip package for custom or not covered with a Fluent API client endpoints with granular control for an HTTP request, response, and http.Client parameters. The client is used internally but rarely required in consumer code.

client := &gosip.SPClient{AuthCnfg: auth}

var req *http.Request
// Initiate API request
// ...

resp, err := client.Execute(req)
if err != nil {
    fmt.Printf("Unable to request api: %v", err)
    return
}

SPClient has Execute method which is a wrapper function injecting SharePoint authentication and ending up calling http.Client's Do method.

Authentication strategies

Auth strategy should be selected corresponding to your SharePoint environment and its configuration.

Import path strategy "github.com/koltyakov/gosip/auth/{strategy}". Where /{strategy} stands for a strategy auth package.

/{strategy}	SPO	On-Prem	Credentials sample(s)
AAD /azurecert	✅	❌	details
AAD /azurecreds	✅	❌	details
AAD /device	✅	❌	details
/saml	✅	❌	[sample](./config/samples/private.spo-user.json)
/addin	✅	❌	[sample](./config/samples/private.spo-addin.json)
/ntlm	❌	✅	[sample](./config/samples/private.onprem-ntlm.json)
/adfs	✅	✅	[spo](./config/samples/private.spo-adfs.json), [on-prem](./config/samples/private.onprem-adfs.json), [on-prem (wap)](./config/samples/private.onprem-wap.json)
/fba	❌	✅	[sample](./config/samples/private.onprem-fba.json)
/tmg	❌	✅	[sample](./config/samples/private.onprem-tmg.json)

JSON and struct representations are different in terms of language notations. So credentials parameters names in private.json files and declared as structs initiators vary.

SAML Auth (SharePoint Online user credentials authentication)

This authentication option uses Microsoft Online Security Token Service https://login.microsoftonline.com/extSTS.srf and SAML tokens in order to obtain an authentication cookie.

// AuthCnfg - SAML auth config structure
type AuthCnfg struct {
    // SPSite or SPWeb URL, which is the context target for the API calls
    SiteURL string `json:"siteUrl"`
    // Username for SharePoint Online, for example `[user]@[company].onmicrosoft.com`
    Username string `json:"username"`
    // User or App password
    Password string `json:"password"`
}

AddIn Only Auth

This type of authentication uses AddIn Only policy and OAuth bearer tokens for authenticating HTTP requests.

// AuthCnfg - AddIn Only auth config structure
type AuthCnfg struct {
    // SPSite or SPWeb URL, which is the context target for the API calls
    SiteURL string `json:"siteUrl"`
    // Client ID obtained when registering the AddIn
    ClientID string `json:"clientId"`
    // Client Secret obtained when registering the AddIn
    ClientSecret string `json:"clientSecret"`
    // Your SharePoint Online tenant ID (optional)
    Realm string `json:"realm"`
}

Realm can be left empty or filled in, which will add small performance improvement. The easiest way to find the tenant is to open SharePoint Online site collection, click Site Settings -> Site App Permissions. Taking any random app, the tenant ID (realm) is the GUID part after the @.

See more details of AddIn Configuration and Permissions.

NTLM Auth (NTLM handshake)

This type of authentication uses an HTTP NTLM handshake to obtain an authentication header.

// AuthCnfg - NTLM auth config structure
type AuthCnfg struct {
    // SPSite or SPWeb URL, which is the context target for the API calls
    SiteURL  string `json:"siteUrl"`
    Domain   string `json:"domain"`   // AD domain name
    Username string `json:"username"` // AD user name
    Password string `json:"password"` // AD user password
}

Gosip uses github.com/Azure/go-ntlmssp NTLM negotiator, however, a custom one also can be provided in case of demand.

ADFS Auth (user credentials authentication)

// AuthCnfg - ADFS auth config structure
type AuthCnfg struct {
    // SPSite or SPWeb URL, which is the context target for the API calls
    SiteURL      string `json:"siteUrl"`
    Username     string `json:"username"`
    Password     string `json:"password"`
    // Following are not required for SPO
    Domain       string `json:"domain"`
    RelyingParty string `json:"relyingParty"`
    AdfsURL      string `json:"adfsUrl"`
    AdfsCookie   string `json:"adfsCookie"`
}

See more details ADFS user credentials authentication.

Gosip's ADFS also supports a scenario of ADFS or NTLM behind WAP (Web Application Proxy) which adds additional auth flow and EdgeAccessCookie involved into play.

FBA/TMG Auth (Form-based authentication)

FBA - Form-based authentication for SharePoint On-Premises.

TMG - Microsoft Forefront Threat Management Gateway, currently is legacy but was a popular way of exposing SharePoint into the external world back in the days.

// AuthCnfg - FBA/TMG auth config structure
type AuthCnfg struct {
    // SPSite or SPWeb URL, which is the context target for the API calls
    SiteURL string `json:"siteUrl"`
    // Username for SharePoint On-Prem, format depends in FBA/TMG settings,
    // can include domain or doesn't
    Username string `json:"username"`
    // User password
    Password string `json:"password"`
}

Secrets encoding

When storing credential in local private.json files, which can be handy in local development scenarios, we strongly recommend to encode secrets such as password or clientSecret using [cpass](./cmd/cpass/README.md). Class converts a secret to an encrypted representation, which can only be decrypted on the same machine where it was generated. That reduces accidental leaks, e.g. together with git commits.

Reference

Many auth flows have been "copied" from node-sp-auth library (used as a blueprint), which we intensively use in Node.js ecosystem for years.

Fluent API and wrapper syntax are inspired by PnPjs, which is also the first-class citizen on almost all our Node.js and front-end projects with SharePoint involved.

📚 Documentation

📦 Samples

License