package impluser import ( "context" "fmt" "slices" "strings" "time" "github.com/SigNoz/signoz/pkg/analytics" "github.com/SigNoz/signoz/pkg/authz" "github.com/SigNoz/signoz/pkg/emailing" "github.com/SigNoz/signoz/pkg/errors" "github.com/SigNoz/signoz/pkg/factory" "github.com/SigNoz/signoz/pkg/modules/organization" "github.com/SigNoz/signoz/pkg/modules/user" root "github.com/SigNoz/signoz/pkg/modules/user" "github.com/SigNoz/signoz/pkg/tokenizer" "github.com/SigNoz/signoz/pkg/types" "github.com/SigNoz/signoz/pkg/types/authtypes" "github.com/SigNoz/signoz/pkg/types/emailtypes" "github.com/SigNoz/signoz/pkg/types/roletypes" "github.com/SigNoz/signoz/pkg/valuer" "github.com/dustin/go-humanize" ) type Module struct { store types.UserStore tokenizer tokenizer.Tokenizer emailing emailing.Emailing settings factory.ScopedProviderSettings orgSetter organization.Setter authz authz.AuthZ analytics analytics.Analytics config user.Config } // This module is a WIP, don't take inspiration from this. func NewModule(store types.UserStore, tokenizer tokenizer.Tokenizer, emailing emailing.Emailing, providerSettings factory.ProviderSettings, orgSetter organization.Setter, authz authz.AuthZ, analytics analytics.Analytics, config user.Config) root.Module { settings := factory.NewScopedProviderSettings(providerSettings, "github.com/SigNoz/signoz/pkg/modules/user/impluser") return &Module{ store: store, tokenizer: tokenizer, emailing: emailing, settings: settings, orgSetter: orgSetter, analytics: analytics, authz: authz, config: config, } } func (m *Module) AcceptInvite(ctx context.Context, token string, password string) (*types.User, error) { invite, err := m.store.GetInviteByToken(ctx, token) if err != nil { return nil, err } user, err := types.NewUser(invite.Name, invite.Email, invite.Role, invite.OrgID) if err != nil { return nil, err } factorPassword, err := types.NewFactorPassword(password, user.ID.StringValue()) if err != nil { return nil, err } err = m.CreateUser(ctx, user, root.WithFactorPassword(factorPassword)) if err != nil { return nil, err } if err := m.DeleteInvite(ctx, invite.OrgID.String(), invite.ID); err != nil { return nil, err } return user, nil } func (m *Module) GetInviteByToken(ctx context.Context, token string) (*types.Invite, error) { invite, err := m.store.GetInviteByToken(ctx, token) if err != nil { return nil, err } return invite, nil } // CreateBulk implements invite.Module. func (m *Module) CreateBulkInvite(ctx context.Context, orgID valuer.UUID, userID valuer.UUID, bulkInvites *types.PostableBulkInviteRequest) ([]*types.Invite, error) { creator, err := m.store.GetUser(ctx, userID) if err != nil { return nil, err } invites := make([]*types.Invite, 0, len(bulkInvites.Invites)) for _, invite := range bulkInvites.Invites { // check if user exists existingUser, err := m.store.GetUserByEmailAndOrgID(ctx, invite.Email, orgID) if err != nil && !errors.Ast(err, errors.TypeNotFound) { return nil, err } if existingUser != nil { if err := existingUser.ErrIfRoot(); err != nil { return nil, errors.WithAdditionalf(err, "cannot send invite to root user") } } if existingUser != nil { return nil, errors.New(errors.TypeAlreadyExists, errors.CodeAlreadyExists, "User already exists with the same email") } // Check if an invite already exists existingInvite, err := m.store.GetInviteByEmailAndOrgID(ctx, invite.Email, orgID) if err != nil && !errors.Ast(err, errors.TypeNotFound) { return nil, err } if existingInvite != nil { return nil, errors.New(errors.TypeAlreadyExists, errors.CodeAlreadyExists, "An invite already exists for this email") } role, err := types.NewRole(invite.Role.String()) if err != nil { return nil, err } newInvite, err := types.NewInvite(invite.Name, role, orgID, invite.Email) if err != nil { return nil, err } newInvite.InviteLink = fmt.Sprintf("%s/signup?token=%s", invite.FrontendBaseUrl, newInvite.Token) invites = append(invites, newInvite) } err = m.store.CreateBulkInvite(ctx, invites) if err != nil { return nil, err } for i := 0; i < len(invites); i++ { m.analytics.TrackUser(ctx, orgID.String(), creator.ID.String(), "Invite Sent", map[string]any{"invitee_email": invites[i].Email, "invitee_role": invites[i].Role}) // if the frontend base url is not provided, we don't send the email if bulkInvites.Invites[i].FrontendBaseUrl == "" { m.settings.Logger().InfoContext(ctx, "frontend base url is not provided, skipping email", "invitee_email", invites[i].Email) continue } if err := m.emailing.SendHTML(ctx, invites[i].Email.String(), "You're Invited to Join SigNoz", emailtypes.TemplateNameInvitationEmail, map[string]any{ "inviter_email": creator.Email, "link": fmt.Sprintf("%s/signup?token=%s", bulkInvites.Invites[i].FrontendBaseUrl, invites[i].Token), }); err != nil { m.settings.Logger().ErrorContext(ctx, "failed to send email", "error", err) } } return invites, nil } func (m *Module) ListInvite(ctx context.Context, orgID string) ([]*types.Invite, error) { return m.store.ListInvite(ctx, orgID) } func (m *Module) DeleteInvite(ctx context.Context, orgID string, id valuer.UUID) error { return m.store.DeleteInvite(ctx, orgID, id) } func (module *Module) CreateUser(ctx context.Context, input *types.User, opts ...root.CreateUserOption) error { createUserOpts := root.NewCreateUserOptions(opts...) // since assign is idempotant multiple calls to assign won't cause issues in case of retries. err := module.authz.Grant(ctx, input.OrgID, roletypes.MustGetSigNozManagedRoleFromExistingRole(input.Role), authtypes.MustNewSubject(authtypes.TypeableUser, input.ID.StringValue(), input.OrgID, nil)) if err != nil { return err } if err := module.store.RunInTx(ctx, func(ctx context.Context) error { if err := module.store.CreateUser(ctx, input); err != nil { return err } if createUserOpts.FactorPassword != nil { if err := module.store.CreatePassword(ctx, createUserOpts.FactorPassword); err != nil { return err } } return nil }); err != nil { return err } traitsOrProperties := types.NewTraitsFromUser(input) module.analytics.IdentifyUser(ctx, input.OrgID.String(), input.ID.String(), traitsOrProperties) module.analytics.TrackUser(ctx, input.OrgID.String(), input.ID.String(), "User Created", traitsOrProperties) return nil } func (m *Module) UpdateUser(ctx context.Context, orgID valuer.UUID, id string, user *types.User, updatedBy string) (*types.User, error) { existingUser, err := m.store.GetUser(ctx, valuer.MustNewUUID(id)) if err != nil { return nil, err } if err := existingUser.ErrIfRoot(); err != nil { return nil, errors.WithAdditionalf(err, "cannot update root user") } requestor, err := m.store.GetUser(ctx, valuer.MustNewUUID(updatedBy)) if err != nil { return nil, err } if user.Role != "" && user.Role != existingUser.Role && requestor.Role != types.RoleAdmin { return nil, errors.New(errors.TypeForbidden, errors.CodeForbidden, "only admins can change roles") } // Make sure that the request is not demoting the last admin user. if user.Role != "" && user.Role != existingUser.Role && existingUser.Role == types.RoleAdmin { adminUsers, err := m.store.GetUsersByRoleAndOrgID(ctx, types.RoleAdmin, orgID) if err != nil { return nil, err } if len(adminUsers) == 1 { return nil, errors.New(errors.TypeForbidden, errors.CodeForbidden, "cannot demote the last admin") } } if user.Role != "" && user.Role != existingUser.Role { err = m.authz.ModifyGrant(ctx, orgID, roletypes.MustGetSigNozManagedRoleFromExistingRole(existingUser.Role), roletypes.MustGetSigNozManagedRoleFromExistingRole(user.Role), authtypes.MustNewSubject(authtypes.TypeableUser, id, orgID, nil), ) if err != nil { return nil, err } } existingUser.Update(user.DisplayName, user.Role) if err := m.UpdateAnyUser(ctx, orgID, existingUser); err != nil { return nil, err } return existingUser, nil } func (module *Module) UpdateAnyUser(ctx context.Context, orgID valuer.UUID, user *types.User) error { if err := module.store.UpdateUser(ctx, orgID, user); err != nil { return err } traits := types.NewTraitsFromUser(user) module.analytics.IdentifyUser(ctx, user.OrgID.String(), user.ID.String(), traits) module.analytics.TrackUser(ctx, user.OrgID.String(), user.ID.String(), "User Updated", traits) if err := module.tokenizer.DeleteIdentity(ctx, user.ID); err != nil { return err } return nil } func (module *Module) DeleteUser(ctx context.Context, orgID valuer.UUID, id string, deletedBy string) error { user, err := module.store.GetUser(ctx, valuer.MustNewUUID(id)) if err != nil { return err } if err := user.ErrIfRoot(); err != nil { return errors.WithAdditionalf(err, "cannot delete root user") } if slices.Contains(types.AllIntegrationUserEmails, types.IntegrationUserEmail(user.Email.String())) { return errors.New(errors.TypeForbidden, errors.CodeForbidden, "integration user cannot be deleted") } // don't allow to delete the last admin user adminUsers, err := module.store.GetUsersByRoleAndOrgID(ctx, types.RoleAdmin, orgID) if err != nil { return err } if len(adminUsers) == 1 && user.Role == types.RoleAdmin { return errors.New(errors.TypeForbidden, errors.CodeForbidden, "cannot delete the last admin") } // since revoke is idempotant multiple calls to revoke won't cause issues in case of retries err = module.authz.Revoke(ctx, orgID, roletypes.MustGetSigNozManagedRoleFromExistingRole(user.Role), authtypes.MustNewSubject(authtypes.TypeableUser, id, orgID, nil)) if err != nil { return err } if err := module.store.DeleteUser(ctx, orgID.String(), user.ID.StringValue()); err != nil { return err } module.analytics.TrackUser(ctx, user.OrgID.String(), user.ID.String(), "User Deleted", map[string]any{ "deleted_by": deletedBy, }) return nil } func (module *Module) GetOrCreateResetPasswordToken(ctx context.Context, userID valuer.UUID) (*types.ResetPasswordToken, error) { user, err := module.store.GetUser(ctx, userID) if err != nil { return nil, err } if err := user.ErrIfRoot(); err != nil { return nil, errors.WithAdditionalf(err, "cannot reset password for root user") } password, err := module.store.GetPasswordByUserID(ctx, userID) if err != nil { if !errors.Ast(err, errors.TypeNotFound) { return nil, err } } if password == nil { // if the user does not have a password, we need to create a new one (common for SSO/SAML users) password = types.MustGenerateFactorPassword(userID.String()) if err := module.store.CreatePassword(ctx, password); err != nil { return nil, err } } // check if a token already exists for this password id existingResetPasswordToken, err := module.store.GetResetPasswordTokenByPasswordID(ctx, password.ID) if err != nil && !errors.Ast(err, errors.TypeNotFound) { return nil, err // return the error if it is not a not found error } // return the existing token if it is not expired if existingResetPasswordToken != nil && !existingResetPasswordToken.IsExpired() { return existingResetPasswordToken, nil // return the existing token if it is not expired } // delete the existing token entry if existingResetPasswordToken != nil { if err := module.store.DeleteResetPasswordTokenByPasswordID(ctx, password.ID); err != nil { return nil, err } } // create a new token resetPasswordToken, err := types.NewResetPasswordToken(password.ID, time.Now().Add(module.config.Password.Reset.MaxTokenLifetime)) if err != nil { return nil, err } // create a new token err = module.store.CreateResetPasswordToken(ctx, resetPasswordToken) if err != nil { return nil, err } return resetPasswordToken, nil } func (module *Module) ForgotPassword(ctx context.Context, orgID valuer.UUID, email valuer.Email, frontendBaseURL string) error { if !module.config.Password.Reset.AllowSelf { return errors.New(errors.TypeUnsupported, errors.CodeUnsupported, "Users are not allowed to reset their password themselves, please contact an admin to reset your password.") } user, err := module.store.GetUserByEmailAndOrgID(ctx, email, orgID) if err != nil { if errors.Ast(err, errors.TypeNotFound) { return nil // for security reasons } return err } if err := user.ErrIfRoot(); err != nil { return errors.WithAdditionalf(err, "cannot reset password for root user") } token, err := module.GetOrCreateResetPasswordToken(ctx, user.ID) if err != nil { module.settings.Logger().ErrorContext(ctx, "failed to create reset password token", "error", err) return err } resetLink := fmt.Sprintf("%s/password-reset?token=%s", frontendBaseURL, token.Token) tokenLifetime := module.config.Password.Reset.MaxTokenLifetime humanizedTokenLifetime := strings.TrimSpace(humanize.RelTime(time.Now(), time.Now().Add(tokenLifetime), "", "")) if err := module.emailing.SendHTML( ctx, user.Email.String(), "A Password Reset Was Requested for SigNoz", emailtypes.TemplateNameResetPassword, map[string]any{ "Link": resetLink, "Expiry": humanizedTokenLifetime, }, ); err != nil { module.settings.Logger().ErrorContext(ctx, "failed to send reset password email", "error", err) return nil } return nil } func (module *Module) UpdatePasswordByResetPasswordToken(ctx context.Context, token string, passwd string) error { resetPasswordToken, err := module.store.GetResetPasswordToken(ctx, token) if err != nil { return err } if resetPasswordToken.IsExpired() { return errors.New(errors.TypeUnauthenticated, errors.CodeUnauthenticated, "reset password token has expired") } password, err := module.store.GetPassword(ctx, resetPasswordToken.PasswordID) if err != nil { return err } user, err := module.store.GetUser(ctx, valuer.MustNewUUID(password.UserID)) if err != nil { return err } if err := user.ErrIfRoot(); err != nil { return errors.WithAdditionalf(err, "cannot reset password for root user") } if err := password.Update(passwd); err != nil { return err } return module.store.UpdatePassword(ctx, password) } func (module *Module) UpdatePassword(ctx context.Context, userID valuer.UUID, oldpasswd string, passwd string) error { user, err := module.store.GetUser(ctx, userID) if err != nil { return err } if err := user.ErrIfRoot(); err != nil { return errors.WithAdditionalf(err, "cannot change password for root user") } password, err := module.store.GetPasswordByUserID(ctx, userID) if err != nil { return err } if !password.Equals(oldpasswd) { return errors.New(errors.TypeInvalidInput, types.ErrCodeIncorrectPassword, "old password is incorrect") } if err := password.Update(passwd); err != nil { return err } if err := module.store.UpdatePassword(ctx, password); err != nil { return err } return module.tokenizer.DeleteTokensByUserID(ctx, userID) } func (module *Module) GetOrCreateUser(ctx context.Context, user *types.User, opts ...root.CreateUserOption) (*types.User, error) { existingUser, err := module.store.GetUserByEmailAndOrgID(ctx, user.Email, user.OrgID) if err != nil { if !errors.Ast(err, errors.TypeNotFound) { return nil, err } } if existingUser != nil { return existingUser, nil } err = module.CreateUser(ctx, user, opts...) if err != nil { return nil, err } return user, nil } func (m *Module) CreateAPIKey(ctx context.Context, apiKey *types.StorableAPIKey) error { return m.store.CreateAPIKey(ctx, apiKey) } func (m *Module) UpdateAPIKey(ctx context.Context, id valuer.UUID, apiKey *types.StorableAPIKey, updaterID valuer.UUID) error { return m.store.UpdateAPIKey(ctx, id, apiKey, updaterID) } func (m *Module) ListAPIKeys(ctx context.Context, orgID valuer.UUID) ([]*types.StorableAPIKeyUser, error) { return m.store.ListAPIKeys(ctx, orgID) } func (m *Module) GetAPIKey(ctx context.Context, orgID, id valuer.UUID) (*types.StorableAPIKeyUser, error) { return m.store.GetAPIKey(ctx, orgID, id) } func (m *Module) RevokeAPIKey(ctx context.Context, id, removedByUserID valuer.UUID) error { return m.store.RevokeAPIKey(ctx, id, removedByUserID) } func (module *Module) CreateFirstUser(ctx context.Context, organization *types.Organization, name string, email valuer.Email, passwd string) (*types.User, error) { user, err := types.NewRootUser(name, email, organization.ID) if err != nil { return nil, err } password, err := types.NewFactorPassword(passwd, user.ID.StringValue()) if err != nil { return nil, err } managedRoles := roletypes.NewManagedRoles(organization.ID) err = module.authz.CreateManagedUserRoleTransactions(ctx, organization.ID, user.ID) if err != nil { return nil, err } if err = module.store.RunInTx(ctx, func(ctx context.Context) error { err = module.orgSetter.Create(ctx, organization, func(ctx context.Context, orgID valuer.UUID) error { err = module.authz.CreateManagedRoles(ctx, orgID, managedRoles) if err != nil { return err } return nil }) if err != nil { return err } err = module.createUserWithoutGrant(ctx, user, root.WithFactorPassword(password)) if err != nil { return err } return nil }); err != nil { return nil, err } return user, nil } func (module *Module) Collect(ctx context.Context, orgID valuer.UUID) (map[string]any, error) { stats := make(map[string]any) count, err := module.store.CountByOrgID(ctx, orgID) if err == nil { stats["user.count"] = count } count, err = module.store.CountAPIKeyByOrgID(ctx, orgID) if err == nil { stats["factor.api_key.count"] = count } return stats, nil } func (module *Module) createUserWithoutGrant(ctx context.Context, input *types.User, opts ...root.CreateUserOption) error { createUserOpts := root.NewCreateUserOptions(opts...) if err := module.store.RunInTx(ctx, func(ctx context.Context) error { if err := module.store.CreateUser(ctx, input); err != nil { return err } if createUserOpts.FactorPassword != nil { if err := module.store.CreatePassword(ctx, createUserOpts.FactorPassword); err != nil { return err } } return nil }); err != nil { return err } traitsOrProperties := types.NewTraitsFromUser(input) module.analytics.IdentifyUser(ctx, input.OrgID.String(), input.ID.String(), traitsOrProperties) module.analytics.TrackUser(ctx, input.OrgID.String(), input.ID.String(), "User Created", traitsOrProperties) return nil }