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(ctx context.Context) (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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthCnfg ¶
type AuthCnfg struct {
SiteURL string `json:"siteUrl"` // SPSite or SPWeb URL, which is the context target for the API calls
Domain string `json:"domain"` // AD domain name (optional)
Username string `json:"username"` // AD user 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": "contoso\\john.doe",
"password": "this-is-not-a-real-password"
}
or
{
"siteUrl": "https://www.contoso.com/sites/test",
"username": "john.doe",
"domain": "contoso",
"password": "this-is-not-a-real-password"
}
func (*AuthCnfg) GetStrategy ¶
GetStrategy gets auth strategy name
func (*AuthCnfg) ParseConfig ¶
ParseConfig parses credentials from a provided JSON byte array content
func (*AuthCnfg) ReadConfig ¶
ReadConfig reads private config with auth options
func (*AuthCnfg) SetMasterkey ¶
SetMasterkey defines custom masterkey
func (*AuthCnfg) WriteConfig ¶
WriteConfig writes private config with auth options
Source Files
Click to show internal directories.
Click to hide internal directories.