// Copyright 2016 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. //go:build windows // +build windows // Package negotiate provides access to the Microsoft Negotiate SSP Package. package negotiate import ( "errors" "sync" "syscall" "time" "unsafe" "github.com/alexbrainman/sspi" "github.com/alexbrainman/sspi/internal/common" ) // TODO: maybe (if possible) move all winapi related out of sspi and into sspi/internal/winapi // PackageInfo contains the Negotiate SSP package description. // // It's initialized best-effort during init. During early boot it may not // yet be loaded & available and thus this will be nil. // // Deprecated: use GetPackageInfo instead. var PackageInfo *sspi.PackageInfo func init() { PackageInfo, _ = GetPackageInfo() } var ( pkgInfoMu sync.Mutex pkgInfo *sspi.PackageInfo ) // GetPackageInfo returns the Negotiate SSP package description. func GetPackageInfo() (*sspi.PackageInfo, error) { pkgInfoMu.Lock() defer pkgInfoMu.Unlock() if pkgInfo != nil { return pkgInfo, nil } v, err := sspi.QueryPackageInfo(sspi.NEGOSSP_NAME) if err != nil { return nil, err } pkgInfo = v return v, nil } func acquireCredentials(principalName string, creduse uint32, ai *sspi.SEC_WINNT_AUTH_IDENTITY) (*sspi.Credentials, error) { c, err := sspi.AcquireCredentials(principalName, sspi.NEGOSSP_NAME, creduse, (*byte)(unsafe.Pointer(ai))) if err != nil { return nil, err } return c, nil } // AcquireCurrentUserCredentials acquires credentials of currently // logged on user. These will be used by the client to authenticate // itself to the server. It will also be used by the server // to impersonate the user. func AcquireCurrentUserCredentials() (*sspi.Credentials, error) { return acquireCredentials("", sspi.SECPKG_CRED_OUTBOUND, nil) } // AcquireUserCredentials acquires credentials of user described by // domain, username and password. These will be used by the client to // authenticate itself to the server. It will also be used by the // server to impersonate the user. func AcquireUserCredentials(domain, username, password string) (*sspi.Credentials, error) { ai, err := common.BuildAuthIdentity(domain, username, password) if err != nil { return nil, err } return acquireCredentials("", sspi.SECPKG_CRED_OUTBOUND, ai) } // AcquireServerCredentials acquires server credentials that will // be used to authenticate clients. // The principalName parameter is passed to the underlying call to // the winapi AcquireCredentialsHandle function (and specifies the // name of the principal whose credentials the underlying handle // will reference). // As a special case, using an empty string for the principal name // will require the credential of the user under whose security context // the current process is running. func AcquireServerCredentials(principalName string) (*sspi.Credentials, error) { return acquireCredentials(principalName, sspi.SECPKG_CRED_INBOUND, nil) } // ClientContext is used by the client to manage all steps of Negotiate negotiation. type ClientContext struct { sctxt *sspi.Context targetName *uint16 } // NewClientContext creates a new client context. It uses client // credentials cred generated by AcquireCurrentUserCredentials or // AcquireUserCredentials and SPN to start a client Negotiate // negotiation sequence. targetName is the service principal name // (SPN) or the security context of the destination server. // NewClientContext returns a new token to be sent to the server. func NewClientContext(cred *sspi.Credentials, targetName string) (cc *ClientContext, outputToken []byte, err error) { return NewClientContextWithFlags(cred, targetName, sspi.ISC_REQ_CONNECTION) } // NewClientContextWithFlags creates a new client context. It uses client // credentials cred generated by AcquireCurrentUserCredentials or // AcquireUserCredentials and SPN to start a client Negotiate // negotiation sequence. targetName is the service principal name // (SPN) or the security context of the destination server. // The flags parameter is used to indicate requests for the context // (for example sspi.ISC_REQ_CONFIDENTIALITY|sspi.ISC_REQ_REPLAY_DETECT) // NewClientContextWithFlags returns a new token to be sent to the server. func NewClientContextWithFlags(cred *sspi.Credentials, targetName string, flags uint32) (cc *ClientContext, outputToken []byte, err error) { var tname *uint16 if len(targetName) > 0 { p, err2 := syscall.UTF16FromString(targetName) if err2 != nil { return nil, nil, err2 } if len(p) > 0 { tname = &p[0] } } pkgInfo, err := GetPackageInfo() if err != nil { return nil, nil, err } otoken := make([]byte, pkgInfo.MaxToken) c := sspi.NewClientContext(cred, flags) authCompleted, n, err2 := common.UpdateContext(c, otoken, nil, tname) if err2 != nil { return nil, nil, err2 } if authCompleted { c.Release() return nil, nil, errors.New("negotiate authentication should not be completed yet") } if n == 0 { c.Release() return nil, nil, errors.New("negotiate token should not be empty") } otoken = otoken[:n] return &ClientContext{sctxt: c, targetName: tname}, otoken, nil } // Release free up resources associated with client context c. func (c *ClientContext) Release() error { if c == nil { return nil } return c.sctxt.Release() } // Expiry returns c expiry time. func (c *ClientContext) Expiry() time.Time { return c.sctxt.Expiry() } // Update advances client part of Negotiate negotiation c. It uses // token received from the server and returns true if client part // of authentication is complete. It also returns new token to be // sent to the server. func (c *ClientContext) Update(token []byte) (authCompleted bool, outputToken []byte, err error) { pkgInfo, err := GetPackageInfo() if err != nil { return false, nil, err } otoken := make([]byte, pkgInfo.MaxToken) authDone, n, err2 := common.UpdateContext(c.sctxt, otoken, token, c.targetName) if err2 != nil { return false, nil, err2 } if n == 0 && !authDone { return false, nil, errors.New("negotiate token should not be empty") } otoken = otoken[:n] return authDone, otoken, nil } // Sizes queries the client context for the sizes used in per-message // functions. It returns the maximum token size used in authentication // exchanges, the maximum signature size, the preferred integral size of // messages, the size of any security trailer, and any error. func (c *ClientContext) Sizes() (uint32, uint32, uint32, uint32, error) { return c.sctxt.Sizes() } // MakeSignature uses the established client context to create a signature // for the given message using the provided quality of protection flags and // sequence number. It returns the signature token in addition to any error. func (c *ClientContext) MakeSignature(msg []byte, qop, seqno uint32) ([]byte, error) { return common.MakeSignature(c.sctxt, msg, qop, seqno) } // VerifySignature uses the established client context and signature token // to check that the provided message hasn't been tampered or received out // of sequence. It returns any quality of protection flags and any error // that occurred. func (c *ClientContext) VerifySignature(msg, token []byte, seqno uint32) (uint32, error) { return common.VerifySignature(c.sctxt, msg, token, seqno) } // EncryptMessage uses the established client context to encrypt a message // using the provided quality of protection flags and sequence number. // It returns the signature token in addition to any error. // IMPORTANT: the input msg parameter is updated in place by the low-level windows api // so must be copied if the initial content should not be modified. func (c *ClientContext) EncryptMessage(msg []byte, qop, seqno uint32) ([]byte, error) { return common.EncryptMessage(c.sctxt, msg, qop, seqno) } // DecryptMessage uses the established client context to decrypt a message // using the provided sequence number. // It returns the quality of protection flag and the decrypted message in addition to any error. func (c *ClientContext) DecryptMessage(msg []byte, seqno uint32) (uint32, []byte, error) { return common.DecryptMessage(c.sctxt, msg, seqno) } // VerifyFlags determines if all flags used to construct the client context // were honored (see NewClientContextWithFlags). It should be called after c.Update. func (c *ClientContext) VerifyFlags() error { return c.sctxt.VerifyFlags() } // VerifySelectiveFlags determines if the given flags were honored (see NewClientContextWithFlags). // It should be called after c.Update. func (c *ClientContext) VerifySelectiveFlags(flags uint32) error { return c.sctxt.VerifySelectiveFlags(flags) } // ServerContext is used by the server to manage all steps of Negotiate // negotiation. Once authentication is completed the context can be // used to impersonate client. type ServerContext struct { sctxt *sspi.Context } // NewServerContext creates new server context. It uses server // credentials created by AcquireServerCredentials and token from // the client to start server Negotiate negotiation sequence. // It also returns new token to be sent to the client. func NewServerContext(cred *sspi.Credentials, token []byte) (sc *ServerContext, authDone bool, outputToken []byte, err error) { pkgInfo, err := GetPackageInfo() if err != nil { return nil, false, nil, err } otoken := make([]byte, pkgInfo.MaxToken) c := sspi.NewServerContext(cred, sspi.ASC_REQ_CONNECTION) authDone, n, err2 := common.UpdateContext(c, otoken, token, nil) if err2 != nil { return nil, false, nil, err2 } otoken = otoken[:n] return &ServerContext{sctxt: c}, authDone, otoken, nil } // Release free up resources associated with server context c. func (c *ServerContext) Release() error { if c == nil { return nil } return c.sctxt.Release() } // Expiry returns c expiry time. func (c *ServerContext) Expiry() time.Time { return c.sctxt.Expiry() } // Update advances server part of Negotiate negotiation c. It uses // token received from the client and returns true if server part // of authentication is complete. It also returns new token to be // sent to the client. func (c *ServerContext) Update(token []byte) (authCompleted bool, outputToken []byte, err error) { pkgInfo, err := GetPackageInfo() if err != nil { return false, nil, err } otoken := make([]byte, pkgInfo.MaxToken) authDone, n, err2 := common.UpdateContext(c.sctxt, otoken, token, nil) if err2 != nil { return false, nil, err2 } if n == 0 && !authDone { return false, nil, errors.New("negotiate token should not be empty") } otoken = otoken[:n] return authDone, otoken, nil } const _SECPKG_ATTR_NATIVE_NAMES = 13 type _SecPkgContext_NativeNames struct { ClientName *uint16 ServerName *uint16 } // GetUsername returns the username corresponding to the authenticated client func (c *ServerContext) GetUsername() (string, error) { var ns _SecPkgContext_NativeNames ret := sspi.QueryContextAttributes(c.sctxt.Handle, _SECPKG_ATTR_NATIVE_NAMES, (*byte)(unsafe.Pointer(&ns))) if ret != sspi.SEC_E_OK { return "", ret } sspi.FreeContextBuffer((*byte)(unsafe.Pointer(ns.ServerName))) defer sspi.FreeContextBuffer((*byte)(unsafe.Pointer(ns.ClientName))) return syscall.UTF16ToString((*[2 << 20]uint16)(unsafe.Pointer(ns.ClientName))[:]), nil } // ImpersonateUser changes current OS thread user. New user is // the user as specified by client credentials. func (c *ServerContext) ImpersonateUser() error { return c.sctxt.ImpersonateUser() } // RevertToSelf stops impersonation. It changes current OS thread // user to what it was before ImpersonateUser was executed. func (c *ServerContext) RevertToSelf() error { return c.sctxt.RevertToSelf() } // Sizes queries the server context for the sizes used in per-message // functions. It returns the maximum token size used in authentication // exchanges, the maximum signature size, the preferred integral size of // messages, the size of any security trailer, and any error. func (c *ServerContext) Sizes() (uint32, uint32, uint32, uint32, error) { return c.sctxt.Sizes() } // MakeSignature uses the established server context to create a signature // for the given message using the provided quality of protection flags and // sequence number. It returns the signature token in addition to any error. func (c *ServerContext) MakeSignature(msg []byte, qop, seqno uint32) ([]byte, error) { return common.MakeSignature(c.sctxt, msg, qop, seqno) } // VerifySignature uses the established server context and signature token // to check that the provided message hasn't been tampered or received out // of sequence. It returns any quality of protection flags and any error // that occurred. func (c *ServerContext) VerifySignature(msg, token []byte, seqno uint32) (uint32, error) { return common.VerifySignature(c.sctxt, msg, token, seqno) } // EncryptMessage uses the established server context to encrypt a message // using the provided quality of protection flags and sequence number. // It returns the signature token in addition to any error. // IMPORTANT: the input msg parameter is updated in place by the low-level windows api // so must be copied if the initial content should not be modified. func (c *ServerContext) EncryptMessage(msg []byte, qop, seqno uint32) ([]byte, error) { return common.EncryptMessage(c.sctxt, msg, qop, seqno) } // DecryptMessage uses the established server context to decrypt a message // using the provided sequence number. // It returns the quality of protection flag and the decrypted message in addition to any error. func (c *ServerContext) DecryptMessage(msg []byte, seqno uint32) (uint32, []byte, error) { return common.DecryptMessage(c.sctxt, msg, seqno) }