mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
bbc9b152e6
* MM-68417, MM-68420: API support for PAT expiry and admin policy settings
POST /users/{id}/tokens now accepts a client-supplied expires_at
(previously stripped per the TODO in api4/user.go), and the create app
method enforces two new ServiceSettings:
- EnforcePersonalAccessTokenExpiry (bool, default false): when on,
rejects creates with expires_at == 0
- MaximumPersonalAccessTokenLifetimeDays (int, default 0 = unlimited):
caps how far in the future expires_at may be
Rejections return distinct app error ids so clients can disambiguate:
expires_at_required, expires_at_in_past, expires_at_too_far.
GET /users/{id}/tokens already serializes expires_at via the model's
JSON tag added in MM-68419; clients derive token status (active /
expired / inactive) from is_active + expires_at without a separate
server-side field, keeping the response shape minimal.
The Client4 helper CreateUserAccessToken gained an optional variadic
expiresAt parameter (and the mmctl Client interface + mock match)
rather than introducing a parallel WithExpiry method.
Refs: MM-68417, MM-68420
* MM-68417: exempt bot accounts from PAT expiry enforcement
Mirrors the existing EnableUserAccessTokens bypass at session.go:453,
where bot tokens are allowed even when human PATs are disabled. Bots
are programmatic clients that typically need long-lived credentials,
and integrations that provision them would otherwise break the moment
an admin enables EnforcePersonalAccessTokenExpiry — turning a settings
toggle into a footgun. The expiry policy now applies only to human
users; bots can still be given a future expires_at by callers that
want it, but the server won't require one.
Locked in by a new TestCreateUserAccessToken/bot_tokens_are_exempt
subtest that enables enforcement plus a 30-day cap, creates a bot,
and asserts a non-expiring token is accepted.
Refs: MM-68417
* MM-68420: bound MaximumPersonalAccessTokenLifetimeDays in isValid
Negative values silently meant "unlimited" (the runtime check is `> 0`),
and very large values overflow int64 when computing
`now + days*86_400_000` at token-creation time, producing a wrap-around
that either rejects all reasonable expiries or accepts past timestamps
as valid.
Bound the setting in ServiceSettings.isValid to [0, MaxPersonalAccess
TokenLifetimeDays] where the cap is 36500 (100 years) — past any
realistic operational use and well clear of int64 overflow. Surfaces
as a config validation error rather than a silently-broken runtime
check. New TestServiceSettingsIsValid cases lock in zero, negative,
upper-bound, and above-upper-bound behavior.
Refs: MM-68420
* MM-68417: reject multiple expiresAt values in Client4 helper
CodeRabbit caught that the variadic CreateUserAccessToken silently used
expiresAt[0] when callers passed more than one value, masking a
mis-call instead of failing fast. Return an error in that case so the
misuse is visible at the call site rather than producing a token with
the wrong (or right-but-coincidental) expiry.
Refs: MM-68417
* MM-68417: make expiresAt a required parameter on Client4.CreateUserAccessToken
Drop the variadic in favor of a regular int64 parameter. The variadic
form silently dropped extra values and made a misuse undetectable at
the call site (per CodeRabbit review on PR 36706); the previous fix
guarded against >1 values at runtime, but a required parameter is
strictly better — the compiler now refuses the misuse and every caller
is forced to make a deliberate decision about expiry. Existing callers
that want the old behavior pass 0 (== never expires).
Refs: MM-68417
* MM-68417: add --expires-in flag to mmctl user token generate
Adds an --expires-in duration flag so operators can create expiring
PATs via the CLI. Accepts the standard Go duration syntax plus a
trailing 'd' for days (the common case for token lifetimes), e.g.
--expires-in 90d, --expires-in 12h, --expires-in 1h30m. Empty (the
default) means no expiry — matching prior behavior. Without this
flag the command was unusable once an admin enables
EnforcePersonalAccessTokenExpiry, since every create would fail with
app.user_access_token.expires_at_required.app_error.
Flag parsing now happens before the user-lookup API call so the
command fails fast on invalid input. Regenerated mmctl docs reflect
the new flag.
Refs: MM-68417
* MM-68417: cap --expires-in day count to prevent time.Duration overflow
parseExpiresIn returns time.Duration(days) * 24 * time.Hour, which is
int64 nanoseconds and overflows past ~106751 days (CodeRabbit caught
this). Cap at model.MaxPersonalAccessTokenLifetimeDays (36500) so the
CLI rejects values the server would reject anyway, well below the
int64-overflow point. Adds two test cases (at-cap and beyond-cap) to
TestParseExpiresIn.
Refs: MM-68417
* MM-68420: collapse PAT expiry settings into a single max-lifetime setting
Remove ServiceSettings.EnforcePersonalAccessTokenExpiry and fold the
policy onto MaximumPersonalAccessTokenLifetimeDays: 0 means no policy
(never-expiring tokens allowed, no cap), while a value > 0 requires every
new token to expire within that many days. The two-setting design let an
admin set a maximum but leave enforcement off, silently allowing
never-expiring tokens to sidestep the cap; the only combination the
boolean added (require expiry, no upper bound) has little practical
value. The removed field was introduced on this branch and never
released, so this is not a breaking change.
---------
Co-authored-by: Hanzo Dev <[email protected]>
181 lines
17 KiB
Go
181 lines
17 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
|
|
"github.com/mattermost/mattermost/server/public/model"
|
|
)
|
|
|
|
type Client interface {
|
|
CreateChannel(ctx context.Context, channel *model.Channel) (*model.Channel, *model.Response, error)
|
|
RemoveUserFromChannel(ctx context.Context, channelID, userID string) (*model.Response, error)
|
|
GetChannelMembers(ctx context.Context, channelID string, page, perPage int, etag string) (model.ChannelMembers, *model.Response, error)
|
|
AddChannelMember(ctx context.Context, channelID, userID string) (*model.ChannelMember, *model.Response, error)
|
|
DeleteChannel(ctx context.Context, channelID string) (*model.Response, error)
|
|
PermanentDeleteChannel(ctx context.Context, channelID string) (*model.Response, error)
|
|
MoveChannel(ctx context.Context, channelID, teamID string, force bool) (*model.Channel, *model.Response, error)
|
|
GetPublicChannelsForTeam(ctx context.Context, teamID string, page int, perPage int, etag string) ([]*model.Channel, *model.Response, error)
|
|
GetDeletedChannelsForTeam(ctx context.Context, teamID string, page int, perPage int, etag string) ([]*model.Channel, *model.Response, error)
|
|
GetPrivateChannelsForTeam(ctx context.Context, teamID string, page int, perPage int, etag string) ([]*model.Channel, *model.Response, error)
|
|
GetChannelsForTeamForUser(ctx context.Context, teamID, userID string, includeDeleted bool, etag string) ([]*model.Channel, *model.Response, error)
|
|
RestoreChannel(ctx context.Context, channelID string) (*model.Channel, *model.Response, error)
|
|
PatchChannel(ctx context.Context, channelID string, patch *model.ChannelPatch) (*model.Channel, *model.Response, error)
|
|
GetChannelByName(ctx context.Context, channelName, teamID string, etag string) (*model.Channel, *model.Response, error)
|
|
GetChannelByNameIncludeDeleted(ctx context.Context, channelName, teamID string, etag string) (*model.Channel, *model.Response, error)
|
|
GetChannel(ctx context.Context, channelID string) (*model.Channel, *model.Response, error)
|
|
GetTeam(ctx context.Context, teamID, etag string) (*model.Team, *model.Response, error)
|
|
GetTeamByName(ctx context.Context, name, etag string) (*model.Team, *model.Response, error)
|
|
GetAllTeams(ctx context.Context, etag string, page int, perPage int) ([]*model.Team, *model.Response, error)
|
|
CreateTeam(ctx context.Context, team *model.Team) (*model.Team, *model.Response, error)
|
|
PatchTeam(ctx context.Context, teamID string, patch *model.TeamPatch) (*model.Team, *model.Response, error)
|
|
AddTeamMember(ctx context.Context, teamID, userID string) (*model.TeamMember, *model.Response, error)
|
|
RemoveTeamMember(ctx context.Context, teamID, userID string) (*model.Response, error)
|
|
SoftDeleteTeam(ctx context.Context, teamID string) (*model.Response, error)
|
|
PermanentDeleteTeam(ctx context.Context, teamID string) (*model.Response, error)
|
|
RestoreTeam(ctx context.Context, teamID string) (*model.Team, *model.Response, error)
|
|
UpdateTeamPrivacy(ctx context.Context, teamID string, privacy string) (*model.Team, *model.Response, error)
|
|
SearchTeams(ctx context.Context, search *model.TeamSearch) ([]*model.Team, *model.Response, error)
|
|
GetPost(ctx context.Context, postID string, etag string) (*model.Post, *model.Response, error)
|
|
CreatePost(ctx context.Context, post *model.Post) (*model.Post, *model.Response, error)
|
|
RevealPost(ctx context.Context, postID string) (*model.Post, *model.Response, error)
|
|
GetPostsForChannel(ctx context.Context, channelID string, page, perPage int, etag string, collapsedThreads bool, includeDeleted bool) (*model.PostList, *model.Response, error)
|
|
GetPostsSince(ctx context.Context, channelID string, since int64, collapsedThreads bool) (*model.PostList, *model.Response, error)
|
|
DoAPIPost(ctx context.Context, url string, data string) (*http.Response, error)
|
|
GetLdapGroups(ctx context.Context) ([]*model.Group, *model.Response, error)
|
|
GetGroupsByChannel(ctx context.Context, channelID string, groupOpts model.GroupSearchOpts) ([]*model.GroupWithSchemeAdmin, int, *model.Response, error)
|
|
GetGroupsByTeam(ctx context.Context, teamID string, groupOpts model.GroupSearchOpts) ([]*model.GroupWithSchemeAdmin, int, *model.Response, error)
|
|
RestoreGroup(ctx context.Context, groupID string, etag string) (*model.Group, *model.Response, error)
|
|
GetOldClientLicense(ctx context.Context, etag string) (map[string]string, *model.Response, error)
|
|
UploadLicenseFile(ctx context.Context, data []byte) (*model.Response, error)
|
|
RemoveLicenseFile(ctx context.Context) (*model.Response, error)
|
|
GetLogs(ctx context.Context, page, perPage int) ([]string, *model.Response, error)
|
|
GetRoleByName(ctx context.Context, name string) (*model.Role, *model.Response, error)
|
|
GetAllRoles(ctx context.Context) ([]*model.Role, *model.Response, error)
|
|
PatchRole(ctx context.Context, roleID string, patch *model.RolePatch) (*model.Role, *model.Response, error)
|
|
UploadPlugin(ctx context.Context, file io.Reader) (*model.Manifest, *model.Response, error)
|
|
UploadPluginForced(ctx context.Context, file io.Reader) (*model.Manifest, *model.Response, error)
|
|
RemovePlugin(ctx context.Context, id string) (*model.Response, error)
|
|
EnablePlugin(ctx context.Context, id string) (*model.Response, error)
|
|
DisablePlugin(ctx context.Context, id string) (*model.Response, error)
|
|
GetPlugins(ctx context.Context) (*model.PluginsResponse, *model.Response, error)
|
|
GetUser(ctx context.Context, userID, etag string) (*model.User, *model.Response, error)
|
|
GetUserByUsername(ctx context.Context, userName, etag string) (*model.User, *model.Response, error)
|
|
GetUserByEmail(ctx context.Context, email, etag string) (*model.User, *model.Response, error)
|
|
GetUsersByIds(ctx context.Context, userIDs []string) ([]*model.User, *model.Response, error)
|
|
GetUsersWithCustomQueryParameters(ctx context.Context, page, perPage int, queryParameters string, etag string) ([]*model.User, *model.Response, error)
|
|
GetUsersInTeam(ctx context.Context, teamID string, page, perPage int, etag string) ([]*model.User, *model.Response, error)
|
|
PermanentDeleteUser(ctx context.Context, userID string) (*model.Response, error)
|
|
PermanentDeleteAllUsers(ctx context.Context) (*model.Response, error)
|
|
CreateUser(ctx context.Context, user *model.User) (*model.User, *model.Response, error)
|
|
VerifyUserEmailWithoutToken(ctx context.Context, userID string) (*model.User, *model.Response, error)
|
|
UpdateUserRoles(ctx context.Context, userID, roles string) (*model.Response, error)
|
|
InviteUsersToTeam(ctx context.Context, teamID string, userEmails []string) (*model.Response, error)
|
|
SendPasswordResetEmail(ctx context.Context, email string) (*model.Response, error)
|
|
UpdateUser(ctx context.Context, user *model.User) (*model.User, *model.Response, error)
|
|
UpdateUserAuth(ctx context.Context, userId string, userAuth *model.UserAuth) (*model.UserAuth, *model.Response, error)
|
|
UpdateUserMfa(ctx context.Context, userID, code string, activate bool) (*model.Response, error)
|
|
UpdateUserPassword(ctx context.Context, userID, currentPassword, newPassword string) (*model.Response, error)
|
|
UpdateUserHashedPassword(ctx context.Context, userID, newHashedPassword string) (*model.Response, error)
|
|
CreateUserAccessToken(ctx context.Context, userID, description string, expiresAt int64) (*model.UserAccessToken, *model.Response, error)
|
|
RevokeUserAccessToken(ctx context.Context, tokenID string) (*model.Response, error)
|
|
GetUserAccessTokensForUser(ctx context.Context, userID string, page, perPage int) ([]*model.UserAccessToken, *model.Response, error)
|
|
ConvertUserToBot(ctx context.Context, userID string) (*model.Bot, *model.Response, error)
|
|
ConvertBotToUser(ctx context.Context, userID string, userPatch *model.UserPatch, setSystemAdmin bool) (*model.User, *model.Response, error)
|
|
PromoteGuestToUser(ctx context.Context, userID string) (*model.Response, error)
|
|
DemoteUserToGuest(ctx context.Context, guestID string) (*model.Response, error)
|
|
CreateCommand(ctx context.Context, cmd *model.Command) (*model.Command, *model.Response, error)
|
|
ListCommands(ctx context.Context, teamID string, customOnly bool) ([]*model.Command, *model.Response, error)
|
|
GetCommandById(ctx context.Context, cmdID string) (*model.Command, *model.Response, error)
|
|
UpdateCommand(ctx context.Context, cmd *model.Command) (*model.Command, *model.Response, error)
|
|
MoveCommand(ctx context.Context, teamID string, commandID string) (*model.Response, error)
|
|
DeleteCommand(ctx context.Context, commandID string) (*model.Response, error)
|
|
GetConfig(ctx context.Context) (*model.Config, *model.Response, error)
|
|
GetConfigWithOptions(ctx context.Context, options model.GetConfigOptions) (map[string]any, *model.Response, error)
|
|
GetClientConfig(ctx context.Context, etag string) (map[string]string, *model.Response, error)
|
|
UpdateConfig(context.Context, *model.Config) (*model.Config, *model.Response, error)
|
|
PatchConfig(context.Context, *model.Config) (*model.Config, *model.Response, error)
|
|
ReloadConfig(ctx context.Context) (*model.Response, error)
|
|
MigrateConfig(ctx context.Context, from, to string) (*model.Response, error)
|
|
SyncLdap(ctx context.Context) (*model.Response, error)
|
|
MigrateIdLdap(ctx context.Context, toAttribute string) (*model.Response, error)
|
|
GetUsers(ctx context.Context, page, perPage int, etag string) ([]*model.User, *model.Response, error)
|
|
UpdateUserActive(ctx context.Context, userID string, activate bool) (*model.Response, error)
|
|
UpdateTeam(ctx context.Context, team *model.Team) (*model.Team, *model.Response, error)
|
|
UpdateChannelPrivacy(ctx context.Context, channelID string, privacy model.ChannelType) (*model.Channel, *model.Response, error)
|
|
CreateBot(ctx context.Context, bot *model.Bot) (*model.Bot, *model.Response, error)
|
|
PatchBot(ctx context.Context, userID string, patch *model.BotPatch) (*model.Bot, *model.Response, error)
|
|
GetBots(ctx context.Context, page, perPage int, etag string) ([]*model.Bot, *model.Response, error)
|
|
GetBotsIncludeDeleted(ctx context.Context, page, perPage int, etag string) ([]*model.Bot, *model.Response, error)
|
|
GetBotsOrphaned(ctx context.Context, page, perPage int, etag string) ([]*model.Bot, *model.Response, error)
|
|
DisableBot(ctx context.Context, botUserID string) (*model.Bot, *model.Response, error)
|
|
EnableBot(ctx context.Context, botUserID string) (*model.Bot, *model.Response, error)
|
|
AssignBot(ctx context.Context, botUserID, newOwnerID string) (*model.Bot, *model.Response, error)
|
|
SetServerBusy(ctx context.Context, secs int) (*model.Response, error)
|
|
ClearServerBusy(ctx context.Context) (*model.Response, error)
|
|
GetServerBusy(ctx context.Context) (*model.ServerBusyState, *model.Response, error)
|
|
CheckIntegrity(ctx context.Context) ([]model.IntegrityCheckResult, *model.Response, error)
|
|
InstallPluginFromURL(context.Context, string, bool) (*model.Manifest, *model.Response, error)
|
|
InstallMarketplacePlugin(context.Context, *model.InstallMarketplacePluginRequest) (*model.Manifest, *model.Response, error)
|
|
GetMarketplacePlugins(context.Context, *model.MarketplacePluginFilter) ([]*model.MarketplacePlugin, *model.Response, error)
|
|
MigrateAuthToLdap(ctx context.Context, fromAuthService string, matchField string, force bool) (*model.Response, error)
|
|
MigrateAuthToSaml(ctx context.Context, fromAuthService string, usersMap map[string]string, auto bool) (*model.Response, error)
|
|
GetPing(ctx context.Context) (string, *model.Response, error)
|
|
GetPingWithFullServerStatus(ctx context.Context) (map[string]any, *model.Response, error)
|
|
GetPingWithOptions(ctx context.Context, options model.SystemPingOptions) (map[string]any, *model.Response, error)
|
|
CreateUpload(ctx context.Context, us *model.UploadSession) (*model.UploadSession, *model.Response, error)
|
|
GetUpload(ctx context.Context, uploadID string) (*model.UploadSession, *model.Response, error)
|
|
GetUploadsForUser(ctx context.Context, userID string) ([]*model.UploadSession, *model.Response, error)
|
|
UploadData(ctx context.Context, uploadID string, data io.Reader) (*model.FileInfo, *model.Response, error)
|
|
ListImports(ctx context.Context) ([]string, *model.Response, error)
|
|
DeleteImport(ctx context.Context, name string) (*model.Response, error)
|
|
GetJob(ctx context.Context, id string) (*model.Job, *model.Response, error)
|
|
GetJobs(ctx context.Context, jobType string, status string, page int, perPage int) ([]*model.Job, *model.Response, error)
|
|
GetJobsByType(ctx context.Context, jobType string, page int, perPage int) ([]*model.Job, *model.Response, error)
|
|
CreateJob(ctx context.Context, job *model.Job) (*model.Job, *model.Response, error)
|
|
CancelJob(ctx context.Context, jobID string) (*model.Response, error)
|
|
UpdateJobStatus(ctx context.Context, jobId string, status string, force bool) (*model.Response, error)
|
|
CreateIncomingWebhook(ctx context.Context, hook *model.IncomingWebhook) (*model.IncomingWebhook, *model.Response, error)
|
|
UpdateIncomingWebhook(ctx context.Context, hook *model.IncomingWebhook) (*model.IncomingWebhook, *model.Response, error)
|
|
GetIncomingWebhooks(ctx context.Context, page int, perPage int, etag string) ([]*model.IncomingWebhook, *model.Response, error)
|
|
GetIncomingWebhooksForTeam(ctx context.Context, teamID string, page int, perPage int, etag string) ([]*model.IncomingWebhook, *model.Response, error)
|
|
GetIncomingWebhook(ctx context.Context, hookID string, etag string) (*model.IncomingWebhook, *model.Response, error)
|
|
DeleteIncomingWebhook(ctx context.Context, hookID string) (*model.Response, error)
|
|
CreateOutgoingWebhook(ctx context.Context, hook *model.OutgoingWebhook) (*model.OutgoingWebhook, *model.Response, error)
|
|
UpdateOutgoingWebhook(ctx context.Context, hook *model.OutgoingWebhook) (*model.OutgoingWebhook, *model.Response, error)
|
|
GetOutgoingWebhooks(ctx context.Context, page int, perPage int, etag string) ([]*model.OutgoingWebhook, *model.Response, error)
|
|
GetOutgoingWebhook(ctx context.Context, hookID string) (*model.OutgoingWebhook, *model.Response, error)
|
|
GetOutgoingWebhooksForChannel(ctx context.Context, channelID string, page int, perPage int, etag string) ([]*model.OutgoingWebhook, *model.Response, error)
|
|
GetOutgoingWebhooksForTeam(ctx context.Context, teamID string, page int, perPage int, etag string) ([]*model.OutgoingWebhook, *model.Response, error)
|
|
RegenOutgoingHookToken(ctx context.Context, hookID string) (*model.OutgoingWebhook, *model.Response, error)
|
|
DeleteOutgoingWebhook(ctx context.Context, hookID string) (*model.Response, error)
|
|
ListExports(ctx context.Context) ([]string, *model.Response, error)
|
|
DeleteExport(ctx context.Context, name string) (*model.Response, error)
|
|
DownloadExport(ctx context.Context, name string, wr io.Writer, offset int64) (int64, *model.Response, error)
|
|
DownloadComplianceExport(ctx context.Context, jobID string, wr io.Writer) (string, error)
|
|
GeneratePresignedURL(ctx context.Context, name string) (*model.PresignURLResponse, *model.Response, error)
|
|
ResetSamlAuthDataToEmail(ctx context.Context, includeDeleted bool, dryRun bool, userIDs []string) (int64, *model.Response, error)
|
|
GenerateSupportPacket(ctx context.Context) (io.ReadCloser, string, *model.Response, error)
|
|
GetOAuthApps(ctx context.Context, page, perPage int) ([]*model.OAuthApp, *model.Response, error)
|
|
GetPreferences(ctx context.Context, userId string) (model.Preferences, *model.Response, error)
|
|
GetPreferencesByCategory(ctx context.Context, userId, category string) (model.Preferences, *model.Response, error)
|
|
GetPreferenceByCategoryAndName(ctx context.Context, userId, category, preferenceName string) (*model.Preference, *model.Response, error)
|
|
UpdatePreferences(ctx context.Context, userId string, preferences model.Preferences) (*model.Response, error)
|
|
DeletePreferences(ctx context.Context, userId string, preferences model.Preferences) (*model.Response, error)
|
|
PermanentDeletePost(ctx context.Context, postID string) (*model.Response, error)
|
|
DeletePost(ctx context.Context, postId string) (*model.Response, error)
|
|
ListCPAFields(ctx context.Context) ([]*model.PropertyField, *model.Response, error)
|
|
CreateCPAField(ctx context.Context, field *model.PropertyField) (*model.PropertyField, *model.Response, error)
|
|
PatchCPAField(ctx context.Context, fieldID string, patch *model.PropertyFieldPatch) (*model.PropertyField, *model.Response, error)
|
|
DeleteCPAField(ctx context.Context, fieldID string) (*model.Response, error)
|
|
ListCPAValues(ctx context.Context, userID string) (map[string]json.RawMessage, *model.Response, error)
|
|
PatchCPAValues(ctx context.Context, values map[string]json.RawMessage) (map[string]json.RawMessage, *model.Response, error)
|
|
PatchCPAValuesForUser(ctx context.Context, userID string, values map[string]json.RawMessage) (map[string]json.RawMessage, *model.Response, error)
|
|
GetPostsForReporting(ctx context.Context, options model.ReportPostOptions, cursor model.ReportPostOptionsCursor) (*model.ReportPostListResponse, *model.Response, error)
|
|
}
|