ntlm

README

Alternative NTLM client

See more.

Auth configuration and usage

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/koltyakov/gosip"
	"github.com/koltyakov/gosip/api"
	strategy "github.com/koltyakov/gosip-sandbox/strategies/ntlm"
)

func main() {

	authCnfg := &strategy.AuthCnfg{
		SiteURL:  os.Getenv("SPAUTH_SITEURL"),
		Username: os.Getenv("SPAUTH_USERNAME"),
		Domain:   os.Getenv("SPAUTH_DOMAIN"),
		Password: os.Getenv("SPAUTH_PASSWORD"),
	}

	client := &gosip.SPClient{AuthCnfg: authCnfg}
	sp := api.NewSP(client)

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

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

}

Documentation

Overview

Package ntlm implements NTLM Auth (NTLM handshake) This type of authentication uses HTTP NTLM handshake in order to obtain authentication header. Amongst supported platform versions are:

• On-Premise: 2019, 2016, and 2013

Index

• type AuthCnfg
  • func (c *AuthCnfg) GetAuth() (string, int64, error)
  • func (c *AuthCnfg) GetSiteURL() string
  • func (c *AuthCnfg) GetStrategy() string
  • func (c *AuthCnfg) ParseConfig(byteValue []byte) error
  • func (c *AuthCnfg) ReadConfig(privateFile string) error
  • func (c *AuthCnfg) SetAuth(req *http.Request, httpClient *gosip.SPClient) error
  • func (c *AuthCnfg) SetMasterkey(masterKey string)
  • func (c *AuthCnfg) WriteConfig(privateFile string) error

Types

type AuthCnfg

type AuthCnfg struct {
	SiteURL  string `json:"siteUrl"`  // SPSite or SPWeb URL, which is the context target for the API calls
	Username string `json:"username"` // AD user name
	Domain   string `json:"domain"`   // AD domain name
	Password string `json:"password"` // AD user password
	// contains filtered or unexported fields
}

AuthCnfg - NTLM auth config structure

On-Premises config sample:

{
  "siteUrl": "https://www.contoso.com/sites/test",
	"username": "john.doe",
	"domain": "contoso",
  "password": "this-is-not-a-real-password"
}

func (*AuthCnfg) GetAuth

func (c *AuthCnfg) GetAuth() (string, int64, error)

GetAuth authenticates, receives access token

func (*AuthCnfg) GetSiteURL

func (c *AuthCnfg) GetSiteURL() string

GetSiteURL gets siteURL

func (*AuthCnfg) GetStrategy

func (c *AuthCnfg) GetStrategy() string

GetStrategy gets auth strategy name

func (*AuthCnfg) ParseConfig

func (c *AuthCnfg) ParseConfig(byteValue []byte) error

ParseConfig parses credentials from a provided JSON byte array content

func (*AuthCnfg) ReadConfig

func (c *AuthCnfg) ReadConfig(privateFile string) error

ReadConfig reads private config with auth options

func (*AuthCnfg) SetAuth

func (c *AuthCnfg) SetAuth(req *http.Request, httpClient *gosip.SPClient) error

SetAuth authenticate request

func (*AuthCnfg) SetMasterkey

func (c *AuthCnfg) SetMasterkey(masterKey string)

SetMasterkey defines custom masterkey

func (*AuthCnfg) WriteConfig

func (c *AuthCnfg) WriteConfig(privateFile string) error

WriteConfig writes private config with auth options