Update mattermost library

vendor/github.com/mattermost/ldap/README.md

@@ -1,4 +1,4 @@
-[![GoDoc](https://godoc.org/github.com/go-ldap/ldap?status.svg)](https://godoc.org/github.com/go-ldap/ldap)
+[![Go Reference](https://pkg.go.dev/badge/github.com/mattermost/ldap.svg)](https://pkg.go.dev/github.com/mattermost/ldap)
 [![Build Status](https://travis-ci.org/go-ldap/ldap.svg)](https://travis-ci.org/go-ldap/ldap)
 
 # Basic LDAP v3 functionality for the GO programming language.

vendor/github.com/mattermost/ldap/add.go

@@ -10,9 +10,8 @@
 package ldap
 
 import (
-	"log"
-
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 // Attribute represents an LDAP attribute
@@ -88,13 +87,14 @@ func (l *Conn) Add(addRequest *AddRequest) error {
 		return err
 	}
 
-	if packet.Children[1].Tag == ApplicationAddResponse {
+	tag := packet.Children[1].Tag
+	if tag == ApplicationAddResponse {
 		err := GetLDAPError(packet)
 		if err != nil {
 			return err
 		}
 	} else {
-		log.Printf("Unexpected Response: %d", packet.Children[1].Tag)
+		l.Debug.Log("Unexpected Response", mlog.Uint("tag", tag))
 	}
 	return nil
 }

vendor/github.com/mattermost/ldap/conn.go

@@ -4,7 +4,6 @@ import (
 	"crypto/tls"
 	"errors"
 	"fmt"
-	"log"
 	"net"
 	"net/url"
 	"sync"
@@ -12,6 +11,7 @@ import (
 	"time"
 
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 const (
@@ -210,14 +210,14 @@ func (l *Conn) Close() {
 	defer l.messageMutex.Unlock()
 
 	if l.setClosing() {
-		l.Debug.Printf("Sending quit message and waiting for confirmation")
+		l.Debug.Log("Sending quit message and waiting for confirmation")
 		l.chanMessage <- &messagePacket{Op: MessageQuit}
 		<-l.chanConfirm
 		close(l.chanMessage)
 
-		l.Debug.Printf("Closing network connection")
+		l.Debug.Log("Closing network connection")
 		if err := l.conn.Close(); err != nil {
-			log.Println(err)
+			l.Debug.Log("Error closing network connection", mlog.Err(err))
 		}
 
 		l.wgClose.Done()
@@ -251,7 +251,8 @@ func (l *Conn) StartTLS(config *tls.Config) error {
 	request := ber.Encode(ber.ClassApplication, ber.TypeConstructed, ApplicationExtendedRequest, nil, "Start TLS")
 	request.AppendChild(ber.NewString(ber.ClassContext, ber.TypePrimitive, 0, "1.3.6.1.4.1.1466.20037", "TLS Extended Command"))
 	packet.AppendChild(request)
-	l.Debug.PrintPacket(packet)
+
+	l.Debug.Log("Sending StartTLS packet", PacketToField(packet))
 
 	msgCtx, err := l.sendMessageWithFlags(packet, startTLS)
 	if err != nil {
@@ -259,24 +260,24 @@ func (l *Conn) StartTLS(config *tls.Config) error {
 	}
 	defer l.finishMessage(msgCtx)
 
-	l.Debug.Printf("%d: waiting for response", msgCtx.id)
+	l.Debug.Log("Waiting for StartTLS response", mlog.Int("id", msgCtx.id))
 
 	packetResponse, ok := <-msgCtx.responses
 	if !ok {
 		return NewError(ErrorNetwork, errors.New("ldap: response channel closed"))
 	}
 	packet, err = packetResponse.ReadPacket()
-	l.Debug.Printf("%d: got response %p", msgCtx.id, packet)
-	if err != nil {
-		return err
-	}
-
-	if l.Debug {
+	if l.Debug.Enabled() {
 		if err := addLDAPDescriptions(packet); err != nil {
 			l.Close()
 			return err
 		}
-		l.Debug.PrintPacket(packet)
+
+		l.Debug.Log("Got response %p", mlog.Err(err), mlog.Int("id", msgCtx.id), PacketToField(packet), mlog.Err(err))
+	}
+
+	if err != nil {
+		return err
 	}
 
 	if err := GetLDAPError(packet); err == nil {
@@ -317,7 +318,7 @@ func (l *Conn) sendMessageWithFlags(packet *ber.Packet, flags sendMessageFlags)
 		return nil, NewError(ErrorNetwork, errors.New("ldap: connection closed"))
 	}
 	l.messageMutex.Lock()
-	l.Debug.Printf("flags&startTLS = %d", flags&startTLS)
+
 	if l.isStartingTLS {
 		l.messageMutex.Unlock()
 		return nil, NewError(ErrorNetwork, errors.New("ldap: connection is in startls phase"))
@@ -382,8 +383,8 @@ func (l *Conn) sendProcessMessage(message *messagePacket) bool {
 
 func (l *Conn) processMessages() {
 	defer func() {
-		if err := recover(); err != nil {
-			log.Printf("ldap: recovered panic in processMessages: %v", err)
+		if r := recover(); r != nil {
+			l.Debug.Log("Recovered panic in processMessages", mlog.Any("panic", r))
 		}
 		for messageID, msgCtx := range l.messageContexts {
 			// If we are closing due to an error, inform anyone who
@@ -391,7 +392,7 @@ func (l *Conn) processMessages() {
 			if l.IsClosing() && l.closeErr.Load() != nil {
 				msgCtx.sendResponse(&PacketResponse{Error: l.closeErr.Load().(error)})
 			}
-			l.Debug.Printf("Closing channel for MessageID %d", messageID)
+			l.Debug.Log("Closing channel for MessageID", mlog.Int("message_id", messageID))
 			close(msgCtx.responses)
 			delete(l.messageContexts, messageID)
 		}
@@ -407,16 +408,14 @@ func (l *Conn) processMessages() {
 		case message := <-l.chanMessage:
 			switch message.Op {
 			case MessageQuit:
-				l.Debug.Printf("Shutting down - quit message received")
+				l.Debug.Log("Quit message received: Shutting down")
 				return
 			case MessageRequest:
 				// Add to message list and write to network
-				l.Debug.Printf("Sending message %d", message.MessageID)
-
 				buf := message.Packet.Bytes()
 				_, err := l.conn.Write(buf)
 				if err != nil {
-					l.Debug.Printf("Error Sending Message: %s", err.Error())
+					l.Debug.Log("Error Sending Message", mlog.Err(err))
 					message.Context.sendResponse(&PacketResponse{Error: fmt.Errorf("unable to send request: %s", err)})
 					close(message.Context.responses)
 					break
@@ -431,8 +430,8 @@ func (l *Conn) processMessages() {
 				if requestTimeout > 0 {
 					go func() {
 						defer func() {
-							if err := recover(); err != nil {
-								log.Printf("ldap: recovered panic in RequestTimeout: %v", err)
+							if r := recover(); r != nil {
+								l.Debug.Log("Recovered panic in RequestTimeout", mlog.Any("panic", r))
 							}
 						}()
 						time.Sleep(requestTimeout)
@@ -444,24 +443,27 @@ func (l *Conn) processMessages() {
 					}()
 				}
 			case MessageResponse:
-				l.Debug.Printf("Receiving message %d", message.MessageID)
 				if msgCtx, ok := l.messageContexts[message.MessageID]; ok {
 					msgCtx.sendResponse(&PacketResponse{message.Packet, nil})
 				} else {
-					log.Printf("Received unexpected message %d, %v", message.MessageID, l.IsClosing())
-					l.Debug.PrintPacket(message.Packet)
+					l.Debug.Log(
+						"Received unexpected message",
+						mlog.Int("message_id", message.MessageID),
+						mlog.Bool("is_closing", l.IsClosing()),
+						PacketToField(message.Packet),
+					)
 				}
 			case MessageTimeout:
 				// Handle the timeout by closing the channel
 				// All reads will return immediately
 				if msgCtx, ok := l.messageContexts[message.MessageID]; ok {
-					l.Debug.Printf("Receiving message timeout for %d", message.MessageID)
+					l.Debug.Log("Receiving message timeout", mlog.Int("message_id", message.MessageID))
 					msgCtx.sendResponse(&PacketResponse{message.Packet, errors.New("ldap: connection timed out")})
 					delete(l.messageContexts, message.MessageID)
 					close(msgCtx.responses)
 				}
 			case MessageFinish:
-				l.Debug.Printf("Finished message %d", message.MessageID)
+				l.Debug.Log("Finished message", mlog.Int("message_id", message.MessageID))
 				if msgCtx, ok := l.messageContexts[message.MessageID]; ok {
 					delete(l.messageContexts, message.MessageID)
 					close(msgCtx.responses)
@@ -474,8 +476,8 @@ func (l *Conn) processMessages() {
 func (l *Conn) reader() {
 	cleanstop := false
 	defer func() {
-		if err := recover(); err != nil {
-			log.Printf("ldap: recovered panic in reader: %v", err)
+		if r := recover(); r != nil {
+			l.Debug.Log("Recovered panic in reader", mlog.Any("panic", r))
 		}
 		if !cleanstop {
 			l.Close()
@@ -484,7 +486,7 @@ func (l *Conn) reader() {
 
 	for {
 		if cleanstop {
-			l.Debug.Printf("reader clean stopping (without closing the connection)")
+			l.Debug.Log("Reader clean stopping (without closing the connection)")
 			return
 		}
 		packet, err := ber.ReadPacket(l.conn)
@@ -492,15 +494,15 @@ func (l *Conn) reader() {
 			// A read error is expected here if we are closing the connection...
 			if !l.IsClosing() {
 				l.closeErr.Store(fmt.Errorf("unable to read LDAP response packet: %s", err))
-				l.Debug.Printf("reader error: %s", err)
+				l.Debug.Log("Reader error", mlog.Err(err))
 			}
 			return
 		}
 		if err := addLDAPDescriptions(packet); err != nil {
-			l.Debug.Printf("descriptions error: %s", err)
+			l.Debug.Log("Descriptions error", mlog.Err(err))
 		}
 		if len(packet.Children) == 0 {
-			l.Debug.Printf("Received bad ldap packet")
+			l.Debug.Log("Received bad ldap packet")
 			continue
 		}
 		l.messageMutex.Lock()

vendor/github.com/mattermost/ldap/debug.go

@@ -2,36 +2,48 @@ package ldap
 
 import (
 	"bytes"
-	"log"
 
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
-const LDAP_TRACE_PREFIX = "ldap-trace: "
-
-// debugging type
-//     - has a Printf method to write the debug output
-type debugging bool
+type debugging struct {
+	logger mlog.LoggerIFace
+	levels []mlog.Level
+}
 
 // Enable controls debugging mode.
-func (debug *debugging) Enable(b bool) {
-	*debug = debugging(b)
-}
-
-// Printf writes debug output.
-func (debug debugging) Printf(format string, args ...interface{}) {
-	if debug {
-		format = LDAP_TRACE_PREFIX + format
-		log.Printf(format, args...)
+func (debug *debugging) Enable(logger mlog.LoggerIFace, levels ...mlog.Level) {
+	*debug = debugging{
+		logger: logger,
+		levels: levels,
 	}
 }
 
-// PrintPacket dumps a packet.
-func (debug debugging) PrintPacket(packet *ber.Packet) {
-	if debug {
-		var b bytes.Buffer
-		ber.WritePacket(&b, packet)
-		textToPrint := LDAP_TRACE_PREFIX + b.String()
-		log.Printf(textToPrint)
+func (debug debugging) Enabled() bool {
+	return debug.logger != nil
+}
+
+// Log writes debug output.
+func (debug debugging) Log(msg string, fields ...mlog.Field) {
+	if debug.Enabled() {
+		debug.logger.LogM(debug.levels, msg, fields...)
 	}
 }
+
+type Packet ber.Packet
+
+func (p Packet) LogClone() any {
+	bp := ber.Packet(p)
+	var b bytes.Buffer
+	ber.WritePacket(&b, &bp)
+	return b.String()
+
+}
+
+func PacketToField(packet *ber.Packet) mlog.Field {
+	if packet == nil {
+		return mlog.Any("packet", nil)
+	}
+	return mlog.Any("packet", Packet(*packet))
+}

vendor/github.com/mattermost/ldap/del.go

@@ -6,9 +6,9 @@
 package ldap
 
 import (
-	"log"
-
 	ber "github.com/go-asn1-ber/asn1-ber"
+
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 // DelRequest implements an LDAP deletion request
@@ -52,13 +52,14 @@ func (l *Conn) Del(delRequest *DelRequest) error {
 		return err
 	}
 
-	if packet.Children[1].Tag == ApplicationDelResponse {
+	tag := packet.Children[1].Tag
+	if tag == ApplicationDelResponse {
 		err := GetLDAPError(packet)
 		if err != nil {
 			return err
 		}
 	} else {
-		log.Printf("Unexpected Response: %d", packet.Children[1].Tag)
+		l.Debug.Log("Unexpected Response tag", mlog.Uint("tag", tag))
 	}
 	return nil
 }

vendor/github.com/mattermost/ldap/moddn.go

@@ -1,19 +1,17 @@
 // Package ldap - moddn.go contains ModifyDN functionality
 //
 // https://tools.ietf.org/html/rfc4511
-// ModifyDNRequest ::= [APPLICATION 12] SEQUENCE {
-//      entry           LDAPDN,
-//      newrdn          RelativeLDAPDN,
-//      deleteoldrdn    BOOLEAN,
-//      newSuperior     [0] LDAPDN OPTIONAL }
-//
 //
+//	ModifyDNRequest ::= [APPLICATION 12] SEQUENCE {
+//	     entry           LDAPDN,
+//	     newrdn          RelativeLDAPDN,
+//	     deleteoldrdn    BOOLEAN,
+//	     newSuperior     [0] LDAPDN OPTIONAL }
 package ldap
 
 import (
-	"log"
-
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 // ModifyDNRequest holds the request to modify a DN
@@ -33,7 +31,9 @@ type ModifyDNRequest struct {
 // RDN of the given DN.
 //
 // A call like
-//   mdnReq := NewModifyDNRequest("uid=someone,dc=example,dc=org", "uid=newname", true, "")
+//
+//	mdnReq := NewModifyDNRequest("uid=someone,dc=example,dc=org", "uid=newname", true, "")
+//
 // will setup the request to just rename uid=someone,dc=example,dc=org to
 // uid=newname,dc=example,dc=org.
 func NewModifyDNRequest(dn string, rdn string, delOld bool, newSup string) *ModifyDNRequest {
@@ -73,13 +73,14 @@ func (l *Conn) ModifyDN(m *ModifyDNRequest) error {
 		return err
 	}
 
-	if packet.Children[1].Tag == ApplicationModifyDNResponse {
+	tag := packet.Children[1].Tag
+	if tag == ApplicationModifyDNResponse {
 		err := GetLDAPError(packet)
 		if err != nil {
 			return err
 		}
 	} else {
-		log.Printf("Unexpected Response: %d", packet.Children[1].Tag)
+		l.Debug.Log("Unexpected Response tag", mlog.Uint("tag", tag))
 	}
 	return nil
 }

vendor/github.com/mattermost/ldap/modify.go

@@ -26,9 +26,8 @@
 package ldap
 
 import (
-	"log"
-
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 // Change operation choices
@@ -139,13 +138,14 @@ func (l *Conn) Modify(modifyRequest *ModifyRequest) error {
 		return err
 	}
 
-	if packet.Children[1].Tag == ApplicationModifyResponse {
+	tag := packet.Children[1].Tag
+	if tag == ApplicationModifyResponse {
 		err := GetLDAPError(packet)
 		if err != nil {
 			return err
 		}
 	} else {
-		log.Printf("Unexpected Response: %d", packet.Children[1].Tag)
+		l.Debug.Log("Unexpected Response tag", mlog.Uint("tag", tag))
 	}
 	return nil
 }

vendor/github.com/mattermost/ldap/request.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 
 	ber "github.com/go-asn1-ber/asn1-ber"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
 )
 
 var (
@@ -28,26 +29,31 @@ func (l *Conn) doRequest(req request) (*messageContext, error) {
 		return nil, err
 	}
 
-	if l.Debug {
-		l.Debug.PrintPacket(packet)
-	}
+	l.Debug.Log("Sending package", PacketToField(packet))
 
 	msgCtx, err := l.sendMessage(packet)
 	if err != nil {
 		return nil, err
 	}
-	l.Debug.Printf("%d: returning", msgCtx.id)
+
+	l.Debug.Log("Send package", mlog.Int("id", msgCtx.id))
 	return msgCtx, nil
 }
 
 func (l *Conn) readPacket(msgCtx *messageContext) (*ber.Packet, error) {
-	l.Debug.Printf("%d: waiting for response", msgCtx.id)
+	l.Debug.Log("Waiting for response", mlog.Int("id", msgCtx.id))
 	packetResponse, ok := <-msgCtx.responses
 	if !ok {
 		return nil, NewError(ErrorNetwork, errRespChanClosed)
 	}
 	packet, err := packetResponse.ReadPacket()
-	l.Debug.Printf("%d: got response %p", msgCtx.id, packet)
+	if l.Debug.Enabled() {
+		if err := addLDAPDescriptions(packet); err != nil {
+			return nil, err
+		}
+		l.Debug.Log("Got response", mlog.Int("id", msgCtx.id), PacketToField(packet), mlog.Err(err))
+	}
+
 	if err != nil {
 		return nil, err
 	}
@@ -56,11 +62,5 @@ func (l *Conn) readPacket(msgCtx *messageContext) (*ber.Packet, error) {
 		return nil, NewError(ErrorNetwork, errCouldNotRetMsg)
 	}
 
-	if l.Debug {
-		if err = addLDAPDescriptions(packet); err != nil {
-			return nil, err
-		}
-		l.Debug.PrintPacket(packet)
-	}
 	return packet, nil
 }

vendor/github.com/mattermost/ldap/search.go

@@ -300,10 +300,11 @@ func NewSearchRequest(
 // SearchWithPaging accepts a search request and desired page size in order to execute LDAP queries to fulfill the
 // search request. All paged LDAP query responses will be buffered and the final result will be returned atomically.
 // The following four cases are possible given the arguments:
-//  - given SearchRequest missing a control of type ControlTypePaging: we will add one with the desired paging size
-//  - given SearchRequest contains a control of type ControlTypePaging that isn't actually a ControlPaging: fail without issuing any queries
-//  - given SearchRequest contains a control of type ControlTypePaging with pagingSize equal to the size requested: no change to the search request
-//  - given SearchRequest contains a control of type ControlTypePaging with pagingSize not equal to the size requested: fail without issuing any queries
+//   - given SearchRequest missing a control of type ControlTypePaging: we will add one with the desired paging size
+//   - given SearchRequest contains a control of type ControlTypePaging that isn't actually a ControlPaging: fail without issuing any queries
+//   - given SearchRequest contains a control of type ControlTypePaging with pagingSize equal to the size requested: no change to the search request
+//   - given SearchRequest contains a control of type ControlTypePaging with pagingSize not equal to the size requested: fail without issuing any queries
+//
 // A requested pagingSize of 0 is interpreted as no limit by LDAP servers.
 func (l *Conn) SearchWithPaging(searchRequest *SearchRequest, pagingSize uint32) (*SearchResult, error) {
 	var pagingControl *ControlPaging
@@ -326,7 +327,6 @@ func (l *Conn) SearchWithPaging(searchRequest *SearchRequest, pagingSize uint32)
 	searchResult := new(SearchResult)
 	for {
 		result, err := l.Search(searchRequest)
-		l.Debug.Printf("Looking for Paging Control...")
 		if err != nil {
 			return searchResult, err
 		}
@@ -344,25 +344,21 @@ func (l *Conn) SearchWithPaging(searchRequest *SearchRequest, pagingSize uint32)
 			searchResult.Controls = append(searchResult.Controls, control)
 		}
 
-		l.Debug.Printf("Looking for Paging Control...")
 		pagingResult := FindControl(result.Controls, ControlTypePaging)
 		if pagingResult == nil {
 			pagingControl = nil
-			l.Debug.Printf("Could not find paging control.  Breaking...")
 			break
 		}
 
 		cookie := pagingResult.(*ControlPaging).Cookie
 		if len(cookie) == 0 {
 			pagingControl = nil
-			l.Debug.Printf("Could not find cookie.  Breaking...")
 			break
 		}
 		pagingControl.SetCookie(cookie)
 	}
 
 	if pagingControl != nil {
-		l.Debug.Printf("Abandoning Paging...")
 		pagingControl.PagingSize = 0
 		l.Search(searchRequest)
 	}