mirror of
https://github.com/mattermost/mattermost.git
synced 2026-04-13 04:57:45 -04:00
Some checks are pending
API / build (push) Waiting to run
Server CI / Compute Go Version (push) Waiting to run
Server CI / Check mocks (push) Blocked by required conditions
Server CI / Check go mod tidy (push) Blocked by required conditions
Server CI / check-style (push) Blocked by required conditions
Server CI / Check serialization methods for hot structs (push) Blocked by required conditions
Server CI / Vet API (push) Blocked by required conditions
Server CI / Check migration files (push) Blocked by required conditions
Server CI / Generate email templates (push) Blocked by required conditions
Server CI / Check store layers (push) Blocked by required conditions
Server CI / Check mmctl docs (push) Blocked by required conditions
Server CI / Postgres with binary parameters (push) Blocked by required conditions
Server CI / Postgres (shard 0) (push) Blocked by required conditions
Server CI / Postgres (shard 1) (push) Blocked by required conditions
Server CI / Postgres (shard 2) (push) Blocked by required conditions
Server CI / Postgres (shard 3) (push) Blocked by required conditions
Server CI / Merge Postgres Test Results (push) Blocked by required conditions
Server CI / Postgres FIPS (shard 0) (push) Blocked by required conditions
Server CI / Postgres FIPS (shard 1) (push) Blocked by required conditions
Server CI / Postgres FIPS (shard 2) (push) Blocked by required conditions
Server CI / Postgres FIPS (shard 3) (push) Blocked by required conditions
Server CI / Merge Postgres FIPS Test Results (push) Blocked by required conditions
Server CI / Generate Test Coverage (push) Blocked by required conditions
Server CI / Run mmctl tests (push) Blocked by required conditions
Server CI / Run mmctl tests (FIPS) (push) Blocked by required conditions
Server CI / Build mattermost server app (push) Blocked by required conditions
Tools CI / check-style (mattermost-govet) (push) Waiting to run
Tools CI / Test (mattermost-govet) (push) Waiting to run
Web App CI / check-lint (push) Waiting to run
Web App CI / check-i18n (push) Blocked by required conditions
Web App CI / check-external-links (push) Blocked by required conditions
Web App CI / check-types (push) Blocked by required conditions
Web App CI / test (platform) (push) Blocked by required conditions
Web App CI / test (mattermost-redux) (push) Blocked by required conditions
Web App CI / test (channels shard 1/4) (push) Blocked by required conditions
Web App CI / test (channels shard 2/4) (push) Blocked by required conditions
Web App CI / test (channels shard 3/4) (push) Blocked by required conditions
Web App CI / test (channels shard 4/4) (push) Blocked by required conditions
Web App CI / upload-coverage (push) Blocked by required conditions
Web App CI / build (push) Blocked by required conditions
* Replace hardcoded test passwords with model.NewTestPassword() Add model.NewTestPassword() utility that generates 14+ character passwords meeting complexity requirements for FIPS compliance. Replace all short hardcoded test passwords across the test suite with calls to this function. * Enforce FIPS compliance for passwords and HMAC keys FIPS OpenSSL requires HMAC keys to be at least 14 bytes. PBKDF2 uses the password as the HMAC key internally, so short passwords cause PKCS5_PBKDF2_HMAC to fail. - Add FIPSEnabled and PasswordFIPSMinimumLength build-tag constants - Raise the password minimum length floor to 14 when compiled with requirefips, applied in SetDefaults only when unset and validated independently in IsValid - Return ErrMismatchedHashAndPassword for too-short passwords in PBKDF2 CompareHashAndPassword rather than a cryptic OpenSSL error - Validate atmos/camo HMAC key length under FIPS and lengthen test keys accordingly - Adjust password validation tests to use PasswordFIPSMinimumLength so they work under both FIPS and non-FIPS builds * CI: shard FIPS test suite and extract merge template Run FIPS tests on PRs that touch go.mod or have 'fips' in the branch name. Shard FIPS tests across 4 runners matching the normal Postgres suite. Extract the test result merge logic into a reusable workflow template to deduplicate the normal and FIPS merge jobs. * more * Fix email test helper to respect FIPS minimum password length * Fix test helpers to respect FIPS minimum password length * Remove unnecessary "disable strict password requirements" blocks from test helpers * Fix CodeRabbit review comments on PR #35905 - Add server-test-merge-template.yml to server-ci.yml pull_request.paths so changes to the reusable merge workflow trigger Server CI validation - Skip merge-postgres-fips-test-results job when test-postgres-normal-fips was skipped, preventing failures due to missing artifacts - Set guest.Password on returned guest in CreateGuestAndClient helper to keep contract consistent with CreateUserWithClient - Use shared LowercaseLetters/UppercaseLetters/NUMBERS/PasswordFIPSMinimumLength constants in NewTestPassword() to avoid drift if FIPS floor changes https://claude.ai/code/session_01HmE9QkZM3cAoXn2J7XrK2f * Rename FIPS test artifact to match server-ci-report pattern The server-ci-report job searches for artifacts matching "*-test-logs", so rename from postgres-server-test-logs-fips to postgres-server-fips-test-logs to be included in the report. --------- Co-authored-by: Claude <noreply@anthropic.com>
938 lines
23 KiB
Go
938 lines
23 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package model
|
|
|
|
import (
|
|
"bytes"
|
|
"crypto/rand"
|
|
"database/sql/driver"
|
|
"encoding/base32"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"maps"
|
|
"net"
|
|
"net/mail"
|
|
"net/url"
|
|
"os"
|
|
"regexp"
|
|
"slices"
|
|
"sort"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
"unicode"
|
|
|
|
"github.com/pborman/uuid"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/mattermost/mattermost/server/public/shared/i18n"
|
|
"github.com/mattermost/mattermost/server/public/shared/mlog"
|
|
)
|
|
|
|
const (
|
|
LowercaseLetters = "abcdefghijklmnopqrstuvwxyz"
|
|
UppercaseLetters = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
|
NUMBERS = "0123456789"
|
|
SYMBOLS = " !\"\\#$%&'()*+,-./:;<=>?@[]^_`|~"
|
|
BinaryParamKey = "MM_BINARY_PARAMETERS"
|
|
NoTranslation = "<untranslated>"
|
|
maxPropSizeBytes = 1024 * 1024
|
|
PayloadParseError = "api.payload.parse.error"
|
|
)
|
|
|
|
var ErrMaxPropSizeExceeded = fmt.Errorf("max prop size of %d exceeded", maxPropSizeBytes)
|
|
|
|
//msgp:ignore StringInterface StringSet
|
|
type StringInterface map[string]any
|
|
type StringSet map[string]struct{}
|
|
|
|
//msgp:tuple StringArray
|
|
type StringArray []string
|
|
|
|
func (ss StringSet) Has(val string) bool {
|
|
_, ok := ss[val]
|
|
return ok
|
|
}
|
|
|
|
func (ss StringSet) Add(val string) {
|
|
ss[val] = struct{}{}
|
|
}
|
|
|
|
func (ss StringSet) Val() []string {
|
|
keys := make([]string, 0, len(ss))
|
|
for k := range ss {
|
|
keys = append(keys, k)
|
|
}
|
|
return keys
|
|
}
|
|
|
|
func (sa StringArray) Remove(input string) StringArray {
|
|
for index := range sa {
|
|
if sa[index] == input {
|
|
ret := make(StringArray, 0, len(sa)-1)
|
|
ret = append(ret, sa[:index]...)
|
|
return append(ret, sa[index+1:]...)
|
|
}
|
|
}
|
|
return sa
|
|
}
|
|
|
|
func (sa StringArray) Contains(input string) bool {
|
|
return slices.Contains(sa, input)
|
|
}
|
|
func (sa StringArray) Equals(input StringArray) bool {
|
|
if len(sa) != len(input) {
|
|
return false
|
|
}
|
|
|
|
for index := range sa {
|
|
if sa[index] != input[index] {
|
|
return false
|
|
}
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
// Value converts StringArray to database value
|
|
func (sa StringArray) Value() (driver.Value, error) {
|
|
sz := 0
|
|
for i := range sa {
|
|
sz += len(sa[i])
|
|
if sz > maxPropSizeBytes {
|
|
return nil, ErrMaxPropSizeExceeded
|
|
}
|
|
}
|
|
|
|
j, err := json.Marshal(sa)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// non utf8 characters are not supported https://mattermost.atlassian.net/browse/MM-41066
|
|
return string(j), err
|
|
}
|
|
|
|
// Scan converts database column value to StringArray
|
|
func (sa *StringArray) Scan(value any) error {
|
|
if value == nil {
|
|
return nil
|
|
}
|
|
|
|
buf, ok := value.([]byte)
|
|
if ok {
|
|
return json.Unmarshal(buf, sa)
|
|
}
|
|
|
|
str, ok := value.(string)
|
|
if ok {
|
|
return json.Unmarshal([]byte(str), sa)
|
|
}
|
|
|
|
return errors.New("received value is neither a byte slice nor string")
|
|
}
|
|
|
|
// Scan converts database column value to StringMap
|
|
func (m *StringMap) Scan(value any) error {
|
|
if value == nil {
|
|
return nil
|
|
}
|
|
|
|
buf, ok := value.([]byte)
|
|
if ok {
|
|
return json.Unmarshal(buf, m)
|
|
}
|
|
|
|
str, ok := value.(string)
|
|
if ok {
|
|
return json.Unmarshal([]byte(str), m)
|
|
}
|
|
|
|
return errors.New("received value is neither a byte slice nor string")
|
|
}
|
|
|
|
// Value converts StringMap to database value
|
|
func (m StringMap) Value() (driver.Value, error) {
|
|
ok := m[BinaryParamKey]
|
|
delete(m, BinaryParamKey)
|
|
|
|
sz := 0
|
|
for k := range m {
|
|
sz += len(k) + len(m[k])
|
|
if sz > maxPropSizeBytes {
|
|
return nil, ErrMaxPropSizeExceeded
|
|
}
|
|
}
|
|
|
|
buf, err := json.Marshal(m)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if ok == "true" {
|
|
return append([]byte{0x01}, buf...), nil
|
|
} else if ok == "false" {
|
|
return buf, nil
|
|
}
|
|
// Key wasn't found. We fall back to the default case.
|
|
return string(buf), nil
|
|
}
|
|
|
|
func (m StringMap) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal((map[string]string)(m))
|
|
}
|
|
|
|
func (si *StringInterface) Scan(value any) error {
|
|
if value == nil {
|
|
return nil
|
|
}
|
|
|
|
buf, ok := value.([]byte)
|
|
if ok {
|
|
return json.Unmarshal(buf, si)
|
|
}
|
|
|
|
str, ok := value.(string)
|
|
if ok {
|
|
return json.Unmarshal([]byte(str), si)
|
|
}
|
|
|
|
return errors.New("received value is neither a byte slice nor string")
|
|
}
|
|
|
|
// Value converts StringInterface to database value
|
|
func (si StringInterface) Value() (driver.Value, error) {
|
|
j, err := json.Marshal(si)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if len(j) > maxPropSizeBytes {
|
|
return nil, ErrMaxPropSizeExceeded
|
|
}
|
|
|
|
// non utf8 characters are not supported https://mattermost.atlassian.net/browse/MM-41066
|
|
return string(j), err
|
|
}
|
|
|
|
func (si StringInterface) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal((map[string]any)(si))
|
|
}
|
|
|
|
var translateFunc i18n.TranslateFunc
|
|
var translateFuncOnce sync.Once
|
|
|
|
func AppErrorInit(t i18n.TranslateFunc) {
|
|
translateFuncOnce.Do(func() {
|
|
translateFunc = t
|
|
})
|
|
}
|
|
|
|
//msgp:ignore AppError
|
|
type AppError struct {
|
|
Id string `json:"id"`
|
|
Message string `json:"message"` // Message to be display to the end user without debugging information
|
|
DetailedError string `json:"detailed_error"` // Internal error string to help the developer
|
|
RequestId string `json:"request_id,omitempty"` // The RequestId that's also set in the header
|
|
StatusCode int `json:"status_code,omitempty"` // The http status code
|
|
Where string `json:"-"` // The function where it happened in the form of Struct.Func
|
|
SkipTranslation bool `json:"-"` // Whether translation for the error should be skipped.
|
|
params map[string]any
|
|
wrapped error
|
|
}
|
|
|
|
const maxErrorLength = 1024
|
|
|
|
func (er *AppError) Error() string {
|
|
var sb strings.Builder
|
|
|
|
// render the error information
|
|
if er.Where != "" {
|
|
sb.WriteString(er.Where)
|
|
sb.WriteString(": ")
|
|
}
|
|
|
|
if er.Message != NoTranslation {
|
|
sb.WriteString(er.Message)
|
|
}
|
|
|
|
// only render the detailed error when it's present
|
|
if er.DetailedError != "" {
|
|
if er.Message != NoTranslation {
|
|
sb.WriteString(", ")
|
|
}
|
|
sb.WriteString(er.DetailedError)
|
|
}
|
|
|
|
// render the wrapped error
|
|
err := er.wrapped
|
|
if err != nil {
|
|
sb.WriteString(", ")
|
|
sb.WriteString(err.Error())
|
|
}
|
|
|
|
res := sb.String()
|
|
if len(res) > maxErrorLength {
|
|
res = res[:maxErrorLength] + "..."
|
|
}
|
|
return res
|
|
}
|
|
|
|
func (er *AppError) Translate(T i18n.TranslateFunc) {
|
|
if er.SkipTranslation {
|
|
return
|
|
}
|
|
|
|
if T == nil {
|
|
er.Message = er.Id
|
|
return
|
|
}
|
|
|
|
if er.params == nil {
|
|
er.Message = T(er.Id)
|
|
} else {
|
|
er.Message = T(er.Id, er.params)
|
|
}
|
|
}
|
|
|
|
func (er *AppError) SystemMessage(T i18n.TranslateFunc) string {
|
|
if er.params == nil {
|
|
return T(er.Id)
|
|
}
|
|
return T(er.Id, er.params)
|
|
}
|
|
|
|
func (er *AppError) ToJSON() string {
|
|
// turn the wrapped error into a detailed message
|
|
detailed := er.DetailedError
|
|
defer func() {
|
|
er.DetailedError = detailed
|
|
}()
|
|
|
|
er.wrappedToDetailed()
|
|
|
|
b, _ := json.Marshal(er)
|
|
return string(b)
|
|
}
|
|
|
|
func (er *AppError) wrappedToDetailed() {
|
|
if er.wrapped == nil {
|
|
return
|
|
}
|
|
|
|
if er.DetailedError != "" {
|
|
er.DetailedError += ", "
|
|
}
|
|
|
|
er.DetailedError += er.wrapped.Error()
|
|
}
|
|
|
|
func (er *AppError) Unwrap() error {
|
|
return er.wrapped
|
|
}
|
|
|
|
func (er *AppError) Wrap(err error) *AppError {
|
|
er.wrapped = err
|
|
return er
|
|
}
|
|
|
|
func (er *AppError) WipeDetailed() {
|
|
er.wrapped = nil
|
|
er.DetailedError = ""
|
|
}
|
|
|
|
// AppErrorFromJSON will try to decode the input into an AppError.
|
|
func AppErrorFromJSON(r io.Reader) error {
|
|
data, err := io.ReadAll(r)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
var er AppError
|
|
err = json.NewDecoder(bytes.NewReader(data)).Decode(&er)
|
|
if err != nil {
|
|
// If the request exceeded FileSettings.MaxFileSize a plain error gets returned. Convert it into an AppError.
|
|
if string(data) == "http: request body too large\n" {
|
|
return errors.New("The request was too large. Consider asking your System Admin to raise the FileSettings.MaxFileSize setting.")
|
|
}
|
|
|
|
return errors.Wrapf(err, "failed to decode JSON payload into AppError. Body: %s", string(data))
|
|
}
|
|
|
|
return &er
|
|
}
|
|
|
|
func NewAppError(where string, id string, params map[string]any, details string, status int) *AppError {
|
|
ap := &AppError{
|
|
Id: id,
|
|
params: params,
|
|
Message: id,
|
|
Where: where,
|
|
DetailedError: details,
|
|
StatusCode: status,
|
|
}
|
|
ap.Translate(translateFunc)
|
|
return ap
|
|
}
|
|
|
|
var encoding = base32.NewEncoding("ybndrfg8ejkmcpqxot1uwisza345h769").WithPadding(base32.NoPadding)
|
|
|
|
// NewId is a globally unique identifier. It is a [A-Z0-9] string 26
|
|
// characters long. It is a UUID version 4 Guid that is zbased32 encoded
|
|
// without the padding.
|
|
func NewId() string {
|
|
return encoding.EncodeToString(uuid.NewRandom())
|
|
}
|
|
|
|
// NewUsername is a NewId prefixed with a letter to make valid username
|
|
func NewUsername() string {
|
|
return "a" + NewId()
|
|
}
|
|
|
|
// NewRandomTeamName is a NewId that will be a valid team name.
|
|
func NewRandomTeamName() string {
|
|
teamName := NewId()
|
|
for IsReservedTeamName(teamName) {
|
|
teamName = NewId()
|
|
}
|
|
return teamName
|
|
}
|
|
|
|
// NewRandomString returns a random string of the given length.
|
|
// The resulting entropy will be (5 * length) bits.
|
|
func NewRandomString(length int) string {
|
|
data := make([]byte, 1+(length*5/8))
|
|
rand.Read(data)
|
|
return encoding.EncodeToString(data)[:length]
|
|
}
|
|
|
|
// NewTestPassword generates a password that meets complexity requirements
|
|
// (uppercase, lowercase, number, special character) with a minimum length of 14.
|
|
// The passwords are not cryptographically random. Use only in tests.
|
|
func NewTestPassword() string {
|
|
const (
|
|
lowers = LowercaseLetters
|
|
uppers = UppercaseLetters
|
|
digits = NUMBERS
|
|
specials = "!%^&*(),."
|
|
all = lowers + uppers + digits + specials
|
|
minLen = PasswordFIPSMinimumLength
|
|
)
|
|
|
|
// Read all randomness in one call for performance.
|
|
// We need minLen bytes for character selection + minLen bytes for shuffle indices.
|
|
entropy := make([]byte, 2*minLen)
|
|
if _, err := rand.Read(entropy); err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
pw := make([]byte, minLen)
|
|
pw[0] = uppers[int(entropy[0])%len(uppers)]
|
|
pw[1] = lowers[int(entropy[1])%len(lowers)]
|
|
pw[2] = digits[int(entropy[2])%len(digits)]
|
|
pw[3] = specials[int(entropy[3])%len(specials)]
|
|
for i := 4; i < minLen; i++ {
|
|
pw[i] = all[int(entropy[i])%len(all)]
|
|
}
|
|
|
|
// Shuffle to avoid predictable prefix using remaining entropy.
|
|
for i := len(pw) - 1; i > 0; i-- {
|
|
j := int(entropy[minLen+i]) % (i + 1)
|
|
pw[i], pw[j] = pw[j], pw[i]
|
|
}
|
|
|
|
return string(pw)
|
|
}
|
|
|
|
// GetMillis is a convenience method to get milliseconds since epoch.
|
|
func GetMillis() int64 {
|
|
return GetMillisForTime(time.Now())
|
|
}
|
|
|
|
// GetMillisForTime is a convenience method to get milliseconds since epoch for provided Time.
|
|
func GetMillisForTime(thisTime time.Time) int64 {
|
|
return thisTime.UnixMilli()
|
|
}
|
|
|
|
// GetTimeForMillis is a convenience method to get time.Time for milliseconds since epoch.
|
|
func GetTimeForMillis(millis int64) time.Time {
|
|
return time.UnixMilli(millis)
|
|
}
|
|
|
|
// PadDateStringZeros is a convenience method to pad 2 digit date parts with zeros to meet ISO 8601 format
|
|
func PadDateStringZeros(dateString string) string {
|
|
parts := strings.Split(dateString, "-")
|
|
for index, part := range parts {
|
|
if len(part) == 1 {
|
|
parts[index] = "0" + part
|
|
}
|
|
}
|
|
dateString = strings.Join(parts[:], "-")
|
|
return dateString
|
|
}
|
|
|
|
// GetStartOfDayMillis is a convenience method to get milliseconds since epoch for provided date's start of day
|
|
func GetStartOfDayMillis(thisTime time.Time, timeZoneOffset int) int64 {
|
|
localSearchTimeZone := time.FixedZone("Local Search Time Zone", timeZoneOffset)
|
|
resultTime := time.Date(thisTime.Year(), thisTime.Month(), thisTime.Day(), 0, 0, 0, 0, localSearchTimeZone)
|
|
return GetMillisForTime(resultTime)
|
|
}
|
|
|
|
// GetEndOfDayMillis is a convenience method to get milliseconds since epoch for provided date's end of day
|
|
func GetEndOfDayMillis(thisTime time.Time, timeZoneOffset int) int64 {
|
|
localSearchTimeZone := time.FixedZone("Local Search Time Zone", timeZoneOffset)
|
|
resultTime := time.Date(thisTime.Year(), thisTime.Month(), thisTime.Day(), 23, 59, 59, 999999999, localSearchTimeZone)
|
|
return GetMillisForTime(resultTime)
|
|
}
|
|
|
|
func CopyStringMap(originalMap map[string]string) map[string]string {
|
|
copyMap := make(map[string]string, len(originalMap))
|
|
maps.Copy(copyMap, originalMap)
|
|
return copyMap
|
|
}
|
|
|
|
// MapToJSON converts a map to a json string
|
|
func MapToJSON(objmap map[string]string) string {
|
|
b, _ := json.Marshal(objmap)
|
|
return string(b)
|
|
}
|
|
|
|
// MapBoolToJSON converts a map to a json string
|
|
func MapBoolToJSON(objmap map[string]bool) string {
|
|
b, _ := json.Marshal(objmap)
|
|
return string(b)
|
|
}
|
|
|
|
// MapFromJSON will decode the key/value pair map
|
|
func MapFromJSON(data io.Reader) map[string]string {
|
|
var objmap map[string]string
|
|
|
|
json.NewDecoder(data).Decode(&objmap)
|
|
if objmap == nil {
|
|
return make(map[string]string)
|
|
}
|
|
|
|
return objmap
|
|
}
|
|
|
|
// MapFromJSON will decode the key/value pair map
|
|
func MapBoolFromJSON(data io.Reader) map[string]bool {
|
|
var objmap map[string]bool
|
|
|
|
json.NewDecoder(data).Decode(&objmap)
|
|
if objmap == nil {
|
|
return make(map[string]bool)
|
|
}
|
|
|
|
return objmap
|
|
}
|
|
|
|
func ArrayToJSON(objmap []string) string {
|
|
b, _ := json.Marshal(objmap)
|
|
return string(b)
|
|
}
|
|
|
|
// Deprecated: ArrayFromJSON is deprecated,
|
|
// use SortedArrayFromJSON or NonSortedArrayFromJSON instead
|
|
func ArrayFromJSON(data io.Reader) []string {
|
|
var objmap []string
|
|
json.NewDecoder(data).Decode(&objmap)
|
|
if objmap == nil {
|
|
return make([]string, 0)
|
|
}
|
|
return objmap
|
|
}
|
|
|
|
func SortedArrayFromJSON(data io.Reader) ([]string, error) {
|
|
var obj []string
|
|
err := json.NewDecoder(data).Decode(&obj)
|
|
if err != nil || obj == nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Remove duplicate IDs as it can bring a significant load to the database.
|
|
return RemoveDuplicateStrings(obj), nil
|
|
}
|
|
|
|
func NonSortedArrayFromJSON(data io.Reader) ([]string, error) {
|
|
var obj []string
|
|
err := json.NewDecoder(data).Decode(&obj)
|
|
if err != nil || obj == nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Remove duplicate IDs, but don't sort.
|
|
return RemoveDuplicateStringsNonSort(obj), nil
|
|
}
|
|
|
|
func ArrayFromInterface(data any) []string {
|
|
stringArray := []string{}
|
|
|
|
dataArray, ok := data.([]any)
|
|
if !ok {
|
|
return stringArray
|
|
}
|
|
|
|
for _, v := range dataArray {
|
|
if str, ok := v.(string); ok {
|
|
stringArray = append(stringArray, str)
|
|
}
|
|
}
|
|
|
|
return stringArray
|
|
}
|
|
|
|
func StringInterfaceToJSON(objmap map[string]any) string {
|
|
b, _ := json.Marshal(objmap)
|
|
return string(b)
|
|
}
|
|
|
|
func StringInterfaceFromJSON(data io.Reader) map[string]any {
|
|
var objmap map[string]any
|
|
|
|
json.NewDecoder(data).Decode(&objmap)
|
|
if objmap == nil {
|
|
return make(map[string]any)
|
|
}
|
|
|
|
return objmap
|
|
}
|
|
|
|
func StructFromJSONLimited[V any](data io.Reader, obj *V) error {
|
|
err := json.NewDecoder(data).Decode(&obj)
|
|
if err != nil || obj == nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ToJSON serializes an arbitrary data type to JSON, discarding the error.
|
|
func ToJSON(v any) []byte {
|
|
b, _ := json.Marshal(v)
|
|
return b
|
|
}
|
|
|
|
func GetServerIPAddress(iface string) string {
|
|
var addrs []net.Addr
|
|
if iface == "" {
|
|
var err error
|
|
addrs, err = net.InterfaceAddrs()
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
} else {
|
|
interfaces, err := net.Interfaces()
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
for _, i := range interfaces {
|
|
if i.Name == iface {
|
|
addrs, err = i.Addrs()
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
for _, addr := range addrs {
|
|
if ip, ok := addr.(*net.IPNet); ok && !ip.IP.IsLoopback() && !ip.IP.IsLinkLocalUnicast() && !ip.IP.IsLinkLocalMulticast() {
|
|
if ip.IP.To4() != nil {
|
|
return ip.IP.String()
|
|
}
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
func isLower(s string) bool {
|
|
return strings.ToLower(s) == s
|
|
}
|
|
|
|
func IsValidEmail(input string) bool {
|
|
if !isLower(input) {
|
|
return false
|
|
}
|
|
|
|
if addr, err := mail.ParseAddress(input); err != nil {
|
|
return false
|
|
} else if addr.Address != input {
|
|
// mail.ParseAddress accepts input of the form "Billy Bob <billy@example.com>" or "<billy@example.com>",
|
|
// which we don't allow. We compare the user input with the parsed addr.Address to ensure we only
|
|
// accept plain addresses like "billy@example.com"
|
|
|
|
// Log a warning for admins in case pre-existing users with emails like <billy@example.com>, which used
|
|
// to be valid before https://github.com/mattermost/mattermost/pull/29661, know how to deal with this
|
|
// error. We don't need to check for the case addr.Name != "", since that has always been rejected
|
|
if addr.Name == "" {
|
|
mlog.Warn("email seems to be enclosed in angle brackets, which is not valid; if this relates to an existing user, use the following mmctl command to modify their email: `mmctl user email \"<affecteduser@domain.com>\" affecteduser@domain.com`", mlog.String("email", input))
|
|
}
|
|
return false
|
|
}
|
|
|
|
// mail.ParseAddress accepts quoted strings for the address
|
|
// which can lead to sending to the wrong email address
|
|
// check for multiple '@' symbols and invalidate
|
|
if strings.Count(input, "@") > 1 {
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
var reservedName = []string{
|
|
"admin",
|
|
"api",
|
|
"channel",
|
|
"claim",
|
|
"error",
|
|
"files",
|
|
"help",
|
|
"landing",
|
|
"login",
|
|
"mfa",
|
|
"oauth",
|
|
"plug",
|
|
"plugins",
|
|
"post",
|
|
"signup",
|
|
"boards",
|
|
"playbooks",
|
|
}
|
|
|
|
func IsValidChannelIdentifier(s string) bool {
|
|
return validSimpleAlphaNum.MatchString(s) && len(s) >= ChannelNameMinLength
|
|
}
|
|
|
|
var (
|
|
validAlphaNum = regexp.MustCompile(`^[a-z0-9]+([a-z\-0-9]+|(__)?)[a-z0-9]+$`)
|
|
validAlphaNumHyphenUnderscore = regexp.MustCompile(`^[a-z0-9]+([a-z\-\_0-9]+|(__)?)[a-z0-9]+$`)
|
|
validSimpleAlphaNum = regexp.MustCompile(`^[a-z0-9]+([a-z\-\_0-9]+|(__)?)[a-z0-9]*$`)
|
|
validSimpleAlphaNumHyphenUnderscore = regexp.MustCompile(`^[a-zA-Z0-9\-_]+$`)
|
|
validSimpleAlphaNumHyphenUnderscorePlus = regexp.MustCompile(`^[a-zA-Z0-9+_-]+$`)
|
|
)
|
|
|
|
func isValidAlphaNum(s string) bool {
|
|
return validAlphaNum.MatchString(s)
|
|
}
|
|
|
|
func IsValidAlphaNumHyphenUnderscore(s string, withFormat bool) bool {
|
|
if withFormat {
|
|
return validAlphaNumHyphenUnderscore.MatchString(s)
|
|
}
|
|
return validSimpleAlphaNumHyphenUnderscore.MatchString(s)
|
|
}
|
|
|
|
func IsValidAlphaNumHyphenUnderscorePlus(s string) bool {
|
|
return validSimpleAlphaNumHyphenUnderscorePlus.MatchString(s)
|
|
}
|
|
|
|
func Etag(parts ...any) string {
|
|
var etag strings.Builder
|
|
etag.WriteString(CurrentVersion)
|
|
|
|
for _, part := range parts {
|
|
etag.WriteString(fmt.Sprintf(".%v", part))
|
|
}
|
|
|
|
return etag.String()
|
|
}
|
|
|
|
var (
|
|
validHashtag = regexp.MustCompile(`^(#\pL[\pL\d\-_.]*[\pL\d])$`)
|
|
puncStart = regexp.MustCompile(`^[^\pL\d\s#]+`)
|
|
hashtagStart = regexp.MustCompile(`^#{2,}`)
|
|
puncEnd = regexp.MustCompile(`[^\pL\d\s]+$`)
|
|
)
|
|
|
|
func ParseHashtags(text string) (string, string) {
|
|
words := strings.Fields(text)
|
|
|
|
var hashtagStringSb strings.Builder
|
|
var plainString strings.Builder
|
|
for _, word := range words {
|
|
// trim off surrounding punctuation
|
|
word = puncStart.ReplaceAllString(word, "")
|
|
word = puncEnd.ReplaceAllString(word, "")
|
|
|
|
// and remove extra pound #s
|
|
word = hashtagStart.ReplaceAllString(word, "#")
|
|
|
|
if validHashtag.MatchString(word) {
|
|
hashtagStringSb.WriteString(" " + word)
|
|
} else {
|
|
plainString.WriteString(" " + word)
|
|
}
|
|
}
|
|
hashtagString := hashtagStringSb.String()
|
|
|
|
if len(hashtagString) > 1000 {
|
|
hashtagString = hashtagString[:999]
|
|
lastSpace := strings.LastIndex(hashtagString, " ")
|
|
if lastSpace > -1 {
|
|
hashtagString = hashtagString[:lastSpace]
|
|
} else {
|
|
hashtagString = ""
|
|
}
|
|
}
|
|
|
|
return strings.TrimSpace(hashtagString), strings.TrimSpace(plainString.String())
|
|
}
|
|
|
|
func ClearMentionTags(post string) string {
|
|
post = strings.Replace(post, "<mention>", "", -1)
|
|
post = strings.Replace(post, "</mention>", "", -1)
|
|
return post
|
|
}
|
|
|
|
func IsValidHTTPURL(rawURL string) bool {
|
|
if strings.Index(rawURL, "http://") != 0 && strings.Index(rawURL, "https://") != 0 {
|
|
return false
|
|
}
|
|
|
|
if u, err := url.ParseRequestURI(rawURL); err != nil || u.Scheme == "" || u.Host == "" {
|
|
return false
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
func IsValidId(value string) bool {
|
|
if len(value) != 26 {
|
|
return false
|
|
}
|
|
|
|
for _, r := range value {
|
|
if !unicode.IsLetter(r) && !unicode.IsNumber(r) {
|
|
return false
|
|
}
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
// RemoveDuplicateStrings does an in-place removal of duplicate strings
|
|
// from the input slice. The original slice gets modified.
|
|
func RemoveDuplicateStrings(in []string) []string {
|
|
// In-place de-dup.
|
|
// Copied from https://github.com/golang/go/wiki/SliceTricks#in-place-deduplicate-comparable
|
|
if len(in) == 0 {
|
|
return in
|
|
}
|
|
sort.Strings(in)
|
|
j := 0
|
|
for i := 1; i < len(in); i++ {
|
|
if in[j] == in[i] {
|
|
continue
|
|
}
|
|
j++
|
|
in[j] = in[i]
|
|
}
|
|
return in[:j+1]
|
|
}
|
|
|
|
// RemoveDuplicateStringsNonSort does a removal of duplicate
|
|
// strings using a map.
|
|
func RemoveDuplicateStringsNonSort(in []string) []string {
|
|
allKeys := make(map[string]bool)
|
|
list := []string{}
|
|
for _, item := range in {
|
|
if _, value := allKeys[item]; !value {
|
|
allKeys[item] = true
|
|
list = append(list, item)
|
|
}
|
|
}
|
|
return list
|
|
}
|
|
|
|
func GetPreferredTimezone(timezone StringMap) string {
|
|
if timezone["useAutomaticTimezone"] == "true" {
|
|
return timezone["automaticTimezone"]
|
|
}
|
|
|
|
return timezone["manualTimezone"]
|
|
}
|
|
|
|
// SanitizeUnicode will remove undesirable Unicode characters from a string.
|
|
func SanitizeUnicode(s string) string {
|
|
return strings.Map(filterBlocklist, s)
|
|
}
|
|
|
|
// filterBlocklist returns `r` if it is not in the blocklist, otherwise drop (-1).
|
|
// Blocklist is taken from https://www.w3.org/TR/unicode-xml/#Charlist
|
|
func filterBlocklist(r rune) rune {
|
|
const drop = -1
|
|
switch r {
|
|
case '\u0340', '\u0341': // clones of grave and acute; deprecated in Unicode
|
|
return drop
|
|
case '\u17A3', '\u17D3': // obsolete characters for Khmer; deprecated in Unicode
|
|
return drop
|
|
case '\u2028', '\u2029': // line and paragraph separator
|
|
return drop
|
|
case '\u202A', '\u202B', '\u202C', '\u202D', '\u202E': // BIDI embedding controls
|
|
return drop
|
|
case '\u206A', '\u206B': // activate/inhibit symmetric swapping; deprecated in Unicode
|
|
return drop
|
|
case '\u206C', '\u206D': // activate/inhibit Arabic form shaping; deprecated in Unicode
|
|
return drop
|
|
case '\u206E', '\u206F': // activate/inhibit national digit shapes; deprecated in Unicode
|
|
return drop
|
|
case '\uFFF9', '\uFFFA', '\uFFFB': // interlinear annotation characters
|
|
return drop
|
|
case '\uFEFF': // byte order mark
|
|
return drop
|
|
case '\uFFFC': // object replacement character
|
|
return drop
|
|
}
|
|
|
|
// Scoping for musical notation
|
|
if r >= 0x0001D173 && r <= 0x0001D17A {
|
|
return drop
|
|
}
|
|
|
|
// Language tag code points
|
|
if r >= 0x000E0000 && r <= 0x000E007F {
|
|
return drop
|
|
}
|
|
|
|
return r
|
|
}
|
|
|
|
func IsCloud() bool {
|
|
return os.Getenv("MM_CLOUD_INSTALLATION_ID") != ""
|
|
}
|
|
|
|
func SliceToMapKey(s ...string) map[string]any {
|
|
m := make(map[string]any)
|
|
for i := range s {
|
|
m[s[i]] = struct{}{}
|
|
}
|
|
|
|
if len(s) != len(m) {
|
|
panic("duplicate keys")
|
|
}
|
|
|
|
return m
|
|
}
|
|
|
|
// LimitRunes limits the number of runes in a string to the given maximum.
|
|
// It returns the potentially truncated string and a boolean indicating whether truncation occurred.
|
|
func LimitRunes(s string, maxRunes int) (string, bool) {
|
|
runes := []rune(s)
|
|
if len(runes) > maxRunes {
|
|
return string(runes[:maxRunes]), true
|
|
}
|
|
|
|
return s, false
|
|
}
|
|
|
|
// LimitBytes limits the number of bytes in a string to the given maximum.
|
|
// It returns the potentially truncated string and a boolean indicating whether truncation occurred.
|
|
func LimitBytes(s string, maxBytes int) (string, bool) {
|
|
if len(s) > maxBytes {
|
|
return s[:maxBytes], true
|
|
}
|
|
return s, false
|
|
}
|