Skip to content

The Open Source DocuSign Alternative.

feat: add user security audit logs

David Nguyen7e15058a3a48
diff --git a/apps/web/package.json b/apps/web/package.json
index 89675318f..fd4faa0c1 100644
--- a/apps/web/package.json
+++ b/apps/web/package.json
@@ -45,6 +45,7 @@
"sharp": "0.33.1",
"ts-pattern": "^5.0.5",
"typescript": "5.2.2",
+ "ua-parser-js": "^1.0.37",
"uqr": "^0.1.2",
"zod": "^3.22.4"
},
@@ -53,7 +54,8 @@
"@types/luxon": "^3.3.1",
"@types/node": "20.1.0",
"@types/react": "18.2.18",
- "@types/react-dom": "18.2.7"
+ "@types/react-dom": "18.2.7",
+ "@types/ua-parser-js": "^0.7.39"
},
"overrides": {
"next-auth": {
diff --git a/apps/web/src/app/(dashboard)/settings/security/activity/page.tsx b/apps/web/src/app/(dashboard)/settings/security/activity/page.tsx
new file mode 100644
index 000000000..6e183b0c7
--- /dev/null
+++ b/apps/web/src/app/(dashboard)/settings/security/activity/page.tsx
@@ -0,0 +1,23 @@
+import type { Metadata } from 'next';
+
+import { UserSecurityActivityDataTable } from './user-security-activity-data-table';
+
+export const metadata: Metadata = {
+ title: 'Security activity',
+};
+
+export default function SettingsSecurityActivityPage() {
+ return (
+ <div>
+ <h3 className="text-2xl font-semibold">Security activity</h3>
+
+ <p className="text-muted-foreground mt-2 text-sm">
+ View all recent security activity related to your account.
+ </p>
+
+ <hr className="my-4" />
+
+ <UserSecurityActivityDataTable />
+ </div>
+ );
+}
diff --git a/apps/web/src/app/(dashboard)/settings/security/activity/user-security-activity-data-table.tsx b/apps/web/src/app/(dashboard)/settings/security/activity/user-security-activity-data-table.tsx
new file mode 100644
index 000000000..4937749fc
--- /dev/null
+++ b/apps/web/src/app/(dashboard)/settings/security/activity/user-security-activity-data-table.tsx
@@ -0,0 +1,156 @@
+'use client';
+
+import { usePathname, useRouter, useSearchParams } from 'next/navigation';
+
+import type { DateTimeFormatOptions } from 'luxon';
+import { DateTime } from 'luxon';
+import { UAParser } from 'ua-parser-js';
+
+import { useUpdateSearchParams } from '@documenso/lib/client-only/hooks/use-update-search-params';
+import { USER_SECURITY_AUDIT_LOG_MAP } from '@documenso/lib/constants/auth';
+import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { trpc } from '@documenso/trpc/react';
+import { DataTable } from '@documenso/ui/primitives/data-table';
+import { DataTablePagination } from '@documenso/ui/primitives/data-table-pagination';
+import { Skeleton } from '@documenso/ui/primitives/skeleton';
+import { TableCell } from '@documenso/ui/primitives/table';
+
+import { LocaleDate } from '~/components/formatter/locale-date';
+
+const dateFormat: DateTimeFormatOptions = {
+ ...DateTime.DATETIME_SHORT,
+ hourCycle: 'h12',
+};
+
+export const UserSecurityActivityDataTable = () => {
+ const parser = new UAParser();
+
+ const pathname = usePathname();
+ const router = useRouter();
+ const searchParams = useSearchParams();
+ const updateSearchParams = useUpdateSearchParams();
+
+ const parsedSearchParams = ZBaseTableSearchParamsSchema.parse(
+ Object.fromEntries(searchParams ?? []),
+ );
+
+ const { data, isLoading, isInitialLoading, isLoadingError } =
+ trpc.profile.findUserSecurityAuditLogs.useQuery(
+ {
+ page: parsedSearchParams.page,
+ perPage: parsedSearchParams.perPage,
+ },
+ {
+ keepPreviousData: true,
+ },
+ );
+
+ const onPaginationChange = (page: number, perPage: number) => {
+ updateSearchParams({
+ page,
+ perPage,
+ });
+ };
+
+ const results = data ?? {
+ data: [],
+ perPage: 10,
+ currentPage: 1,
+ totalPages: 1,
+ };
+
+ return (
+ <DataTable
+ columns={[
+ {
+ header: 'Date',
+ accessorKey: 'createdAt',
+ cell: ({ row }) => <LocaleDate format={dateFormat} date={row.original.createdAt} />,
+ },
+ {
+ header: 'Device',
+ cell: ({ row }) => {
+ if (!row.original.userAgent) {
+ return 'N/A';
+ }
+
+ parser.setUA(row.original.userAgent);
+
+ const result = parser.getResult();
+
+ let output = result.os.name;
+
+ if (!output) {
+ return 'N/A';
+ }
+
+ if (result.os.version) {
+ output += ` (${result.os.version})`;
+ }
+
+ return output;
+ },
+ },
+ {
+ header: 'Browser',
+ cell: ({ row }) => {
+ if (!row.original.userAgent) {
+ return 'N/A';
+ }
+
+ parser.setUA(row.original.userAgent);
+
+ const result = parser.getResult();
+
+ return result.browser.name ?? 'N/A';
+ },
+ },
+ {
+ header: 'IP Address',
+ accessorKey: 'ipAddress',
+ cell: ({ row }) => row.original.ipAddress ?? 'N/A',
+ },
+ {
+ header: 'Action',
+ accessorKey: 'type',
+ cell: ({ row }) => USER_SECURITY_AUDIT_LOG_MAP[row.original.type],
+ },
+ ]}
+ data={results.data}
+ perPage={results.perPage}
+ currentPage={results.currentPage}
+ totalPages={results.totalPages}
+ onPaginationChange={onPaginationChange}
+ hasFilters={parsedSearchParams.page !== undefined || parsedSearchParams.perPage !== undefined}
+ onClearFilters={() => router.push(pathname ?? '/')}
+ error={{
+ enable: isLoadingError,
+ }}
+ skeleton={{
+ enable: isLoading && isInitialLoading,
+ rows: 3,
+ component: (
+ <>
+ <TableCell>
+ <Skeleton className="h-4 w-20 rounded-full" />
+ </TableCell>
+ <TableCell>
+ <Skeleton className="h-4 w-12 rounded-full" />
+ </TableCell>
+ <TableCell>
+ <Skeleton className="h-4 w-12 rounded-full" />
+ </TableCell>
+ <TableCell>
+ <Skeleton className="h-4 w-12 rounded-full" />
+ </TableCell>
+ <TableCell>
+ <Skeleton className="h-4 w-12 rounded-full" />
+ </TableCell>
+ </>
+ ),
+ }}
+ >
+ {(table) => <DataTablePagination table={table} />}
+ </DataTable>
+ );
+};
diff --git a/apps/web/src/app/(dashboard)/settings/security/page.tsx b/apps/web/src/app/(dashboard)/settings/security/page.tsx
index 854ba66ce..4e0a40838 100644
--- a/apps/web/src/app/(dashboard)/settings/security/page.tsx
+++ b/apps/web/src/app/(dashboard)/settings/security/page.tsx
@@ -1,7 +1,10 @@
import type { Metadata } from 'next';
+import Link from 'next/link';
import { IDENTITY_PROVIDER_NAME } from '@documenso/lib/constants/auth';
import { getRequiredServerComponentSession } from '@documenso/lib/next-auth/get-server-component-session';
+import { Alert, AlertDescription, AlertTitle } from '@documenso/ui/primitives/alert';
+import { Button } from '@documenso/ui/primitives/button';
import { AuthenticatorApp } from '~/components/forms/2fa/authenticator-app';
import { RecoveryCodes } from '~/components/forms/2fa/recovery-codes';
@@ -26,43 +29,74 @@ export default async function SecuritySettingsPage() {
{user.identityProvider === 'DOCUMENSO' ? (
<div>
- <PasswordForm user={user} className="max-w-xl" />
+ <PasswordForm user={user} />
- <hr className="mb-4 mt-8" />
+ <hr className="border-border/50 mt-6" />
- <h4 className="text-lg font-medium">Two Factor Authentication</h4>
+ <Alert
+ className="mt-6 flex flex-col justify-between p-6 sm:flex-row sm:items-center"
+ variant="neutral"
+ >
+ <div className="mb-4 sm:mb-0">
+ <AlertTitle>Two factor authentication</AlertTitle>
- <p className="text-muted-foreground mt-2 text-sm">
- Add and manage your two factor security settings to add an extra layer of security to
- your account!
- </p>
-
- <div className="mt-4 max-w-xl">
- <h5 className="font-medium">Two-factor methods</h5>
+ <AlertDescription className="mr-4">
+ Create one-time passwords that serve as a secondary authentication method for
+ confirming your identity when requested during the sign-in process.
+ </AlertDescription>
+ </div>
<AuthenticatorApp isTwoFactorEnabled={user.twoFactorEnabled} />
- </div>
+ </Alert>
{user.twoFactorEnabled && (
- <div className="mt-4 max-w-xl">
- <h5 className="font-medium">Recovery methods</h5>
+ <Alert
+ className="mt-6 flex flex-col justify-between p-6 sm:flex-row sm:items-center"
+ variant="neutral"
+ >
+ <div className="mb-4 sm:mb-0">
+ <AlertTitle>Recovery codes</AlertTitle>
+
+ <AlertDescription className="mr-4">
+ Two factor authentication recovery codes are used to access your account in the
+ event that you lose access to your authenticator app.
+ </AlertDescription>
+ </div>
<RecoveryCodes isTwoFactorEnabled={user.twoFactorEnabled} />
- </div>
+ </Alert>
)}
</div>
) : (
- <div>
- <h4 className="text-lg font-medium">
+ <Alert className="p-6" variant="neutral">
+ <AlertTitle>
Your account is managed by {IDENTITY_PROVIDER_NAME[user.identityProvider]}
- </h4>
- <p className="text-muted-foreground mt-2 text-sm">
+ </AlertTitle>
+
+ <AlertDescription>
To update your password, enable two-factor authentication, and manage other security
settings, please go to your {IDENTITY_PROVIDER_NAME[user.identityProvider]} account
settings.
- </p>
- </div>
+ </AlertDescription>
+ </Alert>
)}
+
+ <Alert
+ className="mt-6 flex flex-col justify-between p-6 sm:flex-row sm:items-center"
+ variant="neutral"
+ >
+ <div className="mb-4 mr-4 sm:mb-0">
+ <AlertTitle>Recent activity</AlertTitle>
+
+ <AlertDescription className="mr-2">
+ View all recent security activity related to your account.
+ </AlertDescription>
+ </div>
+
+ <Button asChild>
+ <Link href="/settings/security/activity">View activity</Link>
+ </Button>
+ </Alert>
</div>
);
}
diff --git a/apps/web/src/components/forms/2fa/authenticator-app.tsx b/apps/web/src/components/forms/2fa/authenticator-app.tsx
index 1d164bd22..316272e34 100644
--- a/apps/web/src/components/forms/2fa/authenticator-app.tsx
+++ b/apps/web/src/components/forms/2fa/authenticator-app.tsx
@@ -19,27 +19,14 @@ export const AuthenticatorApp = ({ isTwoFactorEnabled }: AuthenticatorAppProps)
return (
<>
- <div className="mt-4 flex flex-col justify-between gap-4 rounded-lg border p-4 md:flex-row md:items-center md:gap-8">
- <div className="flex-1">
- <p>Authenticator app</p>
-
- <p className="text-muted-foreground mt-2 max-w-[50ch] text-sm">
- Create one-time passwords that serve as a secondary authentication method for confirming
- your identity when requested during the sign-in process.
- </p>
- </div>
-
- <div>
- {isTwoFactorEnabled ? (
- <Button variant="destructive" onClick={() => setModalState('disable')} size="sm">
- Disable 2FA
- </Button>
- ) : (
- <Button onClick={() => setModalState('enable')} size="sm">
- Enable 2FA
- </Button>
- )}
- </div>
+ <div className="flex-shrink-0">
+ {isTwoFactorEnabled ? (
+ <Button variant="destructive" onClick={() => setModalState('disable')}>
+ Disable 2FA
+ </Button>
+ ) : (
+ <Button onClick={() => setModalState('enable')}>Enable 2FA</Button>
+ )}
</div>
<EnableAuthenticatorAppDialog
diff --git a/apps/web/src/components/forms/2fa/disable-authenticator-app-dialog.tsx b/apps/web/src/components/forms/2fa/disable-authenticator-app-dialog.tsx
index eafed5500..06211170f 100644
--- a/apps/web/src/components/forms/2fa/disable-authenticator-app-dialog.tsx
+++ b/apps/web/src/components/forms/2fa/disable-authenticator-app-dialog.tsx
@@ -11,6 +11,7 @@ import {
Dialog,
DialogContent,
DialogDescription,
+ DialogFooter,
DialogHeader,
DialogTitle,
} from '@documenso/ui/primitives/dialog';
@@ -145,8 +146,8 @@ export const DisableAuthenticatorAppDialog = ({
/>
</fieldset>
- <div className="flex w-full items-center justify-between">
- <Button type="button" variant="ghost" onClick={() => onOpenChange(false)}>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={() => onOpenChange(false)}>
Cancel
</Button>
@@ -157,7 +158,7 @@ export const DisableAuthenticatorAppDialog = ({
>
Disable 2FA
</Button>
- </div>
+ </DialogFooter>
</form>
</Form>
</DialogContent>
diff --git a/apps/web/src/components/forms/2fa/enable-authenticator-app-dialog.tsx b/apps/web/src/components/forms/2fa/enable-authenticator-app-dialog.tsx
index 0db1c8b50..7a181c4cc 100644
--- a/apps/web/src/components/forms/2fa/enable-authenticator-app-dialog.tsx
+++ b/apps/web/src/components/forms/2fa/enable-authenticator-app-dialog.tsx
@@ -15,6 +15,7 @@ import {
Dialog,
DialogContent,
DialogDescription,
+ DialogFooter,
DialogHeader,
DialogTitle,
} from '@documenso/ui/primitives/dialog';
@@ -190,15 +191,15 @@ export const EnableAuthenticatorAppDialog = ({
)}
/>
- <div className="flex w-full items-center justify-between">
- <Button type="button" variant="ghost" onClick={() => onOpenChange(false)}>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={() => onOpenChange(false)}>
Cancel
</Button>
<Button type="submit" loading={isSetupTwoFactorAuthenticationSubmitting}>
Continue
</Button>
- </div>
+ </DialogFooter>
</form>
</Form>
);
@@ -251,15 +252,15 @@ export const EnableAuthenticatorAppDialog = ({
)}
/>
- <div className="flex w-full items-center justify-between">
- <Button type="button" variant="ghost" onClick={() => onOpenChange(false)}>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={() => onOpenChange(false)}>
Cancel
</Button>
<Button type="submit" loading={isEnableTwoFactorAuthenticationSubmitting}>
Enable 2FA
</Button>
- </div>
+ </DialogFooter>
</form>
</Form>
))
diff --git a/apps/web/src/components/forms/2fa/recovery-codes.tsx b/apps/web/src/components/forms/2fa/recovery-codes.tsx
index 7e8950227..29834c74a 100644
--- a/apps/web/src/components/forms/2fa/recovery-codes.tsx
+++ b/apps/web/src/components/forms/2fa/recovery-codes.tsx
@@ -7,7 +7,6 @@ import { Button } from '@documenso/ui/primitives/button';
import { ViewRecoveryCodesDialog } from './view-recovery-codes-dialog';
type RecoveryCodesProps = {
- // backupCodes: string[] | null;
isTwoFactorEnabled: boolean;
};
@@ -16,22 +15,13 @@ export const RecoveryCodes = ({ isTwoFactorEnabled }: RecoveryCodesProps) => {
return (
<>
- <div className="mt-4 flex flex-col justify-between gap-4 rounded-lg border p-4 md:flex-row md:items-center md:gap-8">
- <div className="flex-1">
- <p>Recovery Codes</p>
-
- <p className="text-muted-foreground mt-2 max-w-[50ch] text-sm">
- Recovery codes are used to access your account in the event that you lose access to your
- authenticator app.
- </p>
- </div>
-
- <div>
- <Button onClick={() => setIsOpen(true)} disabled={!isTwoFactorEnabled} size="sm">
- View Codes
- </Button>
- </div>
- </div>
+ <Button
+ className="flex-shrink-0"
+ onClick={() => setIsOpen(true)}
+ disabled={!isTwoFactorEnabled}
+ >
+ View Codes
+ </Button>
<ViewRecoveryCodesDialog
key={isOpen ? 'open' : 'closed'}
diff --git a/apps/web/src/components/forms/2fa/view-recovery-codes-dialog.tsx b/apps/web/src/components/forms/2fa/view-recovery-codes-dialog.tsx
index 5590a6722..18714332a 100644
--- a/apps/web/src/components/forms/2fa/view-recovery-codes-dialog.tsx
+++ b/apps/web/src/components/forms/2fa/view-recovery-codes-dialog.tsx
@@ -11,6 +11,7 @@ import {
Dialog,
DialogContent,
DialogDescription,
+ DialogFooter,
DialogHeader,
DialogTitle,
} from '@documenso/ui/primitives/dialog';
@@ -119,15 +120,15 @@ export const ViewRecoveryCodesDialog = ({ open, onOpenChange }: ViewRecoveryCode
)}
/>
- <div className="flex w-full items-center justify-between">
- <Button type="button" variant="ghost" onClick={() => onOpenChange(false)}>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={() => onOpenChange(false)}>
Cancel
</Button>
<Button type="submit" loading={isViewRecoveryCodesSubmitting}>
Continue
</Button>
- </div>
+ </DialogFooter>
</form>
</Form>
);
diff --git a/apps/web/src/components/forms/password.tsx b/apps/web/src/components/forms/password.tsx
index 0fa5ad462..03f95ff7f 100644
--- a/apps/web/src/components/forms/password.tsx
+++ b/apps/web/src/components/forms/password.tsx
@@ -137,7 +137,7 @@ export const PasswordForm = ({ className }: PasswordFormProps) => {
/>
</fieldset>
- <div className="mt-4">
+ <div className="ml-auto mt-4">
<Button type="submit" loading={isSubmitting}>
{isSubmitting ? 'Updating password...' : 'Update password'}
</Button>
diff --git a/apps/web/src/components/forms/signin.tsx b/apps/web/src/components/forms/signin.tsx
index 17bb2c57c..b3e4ea019 100644
--- a/apps/web/src/components/forms/signin.tsx
+++ b/apps/web/src/components/forms/signin.tsx
@@ -12,7 +12,13 @@ import { ErrorCode, isErrorCode } from '@documenso/lib/next-auth/error-codes';
import { ZCurrentPasswordSchema } from '@documenso/trpc/server/auth-router/schema';
import { cn } from '@documenso/ui/lib/utils';
import { Button } from '@documenso/ui/primitives/button';
-import { Dialog, DialogContent, DialogHeader, DialogTitle } from '@documenso/ui/primitives/dialog';
+import {
+ Dialog,
+ DialogContent,
+ DialogFooter,
+ DialogHeader,
+ DialogTitle,
+} from '@documenso/ui/primitives/dialog';
import {
Form,
FormControl,
@@ -111,7 +117,6 @@ export const SignInForm = ({ className, isGoogleSSOEnabled }: SignInFormProps) =
const result = await signIn('credentials', {
...credentials,
-
callbackUrl: LOGIN_REDIRECT_PATH,
redirect: false,
});
@@ -270,21 +275,23 @@ export const SignInForm = ({ className, isGoogleSSOEnabled }: SignInFormProps) =
)}
/>
)}
- </fieldset>
- <div className="mt-4 flex items-center justify-between">
- <Button
- type="button"
- variant="ghost"
- onClick={onToggleTwoFactorAuthenticationMethodClick}
- >
- {twoFactorAuthenticationMethod === 'totp' ? 'Use Backup Code' : 'Use Authenticator'}
- </Button>
-
- <Button type="submit" loading={isSubmitting}>
- {isSubmitting ? 'Signing in...' : 'Sign In'}
- </Button>
- </div>
+ <DialogFooter className="mt-4">
+ <Button
+ type="button"
+ variant="secondary"
+ onClick={onToggleTwoFactorAuthenticationMethodClick}
+ >
+ {twoFactorAuthenticationMethod === 'totp'
+ ? 'Use Backup Code'
+ : 'Use Authenticator'}
+ </Button>
+
+ <Button type="submit" loading={isSubmitting}>
+ {isSubmitting ? 'Signing in...' : 'Sign In'}
+ </Button>
+ </DialogFooter>
+ </fieldset>
</form>
</DialogContent>
</Dialog>
diff --git a/apps/web/src/pages/api/auth/[...nextauth].ts b/apps/web/src/pages/api/auth/[...nextauth].ts
index 4039703b8..ed1809691 100644
--- a/apps/web/src/pages/api/auth/[...nextauth].ts
+++ b/apps/web/src/pages/api/auth/[...nextauth].ts
@@ -1,17 +1,75 @@
-// import { NextApiRequest, NextApiResponse } from 'next';
+import type { NextApiRequest, NextApiResponse } from 'next';
+
import NextAuth from 'next-auth';
import { NEXT_AUTH_OPTIONS } from '@documenso/lib/next-auth/auth-options';
+import { extractRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
+import { prisma } from '@documenso/prisma';
+import { UserSecurityAuditLogType } from '@documenso/prisma/client';
+
+export default async function auth(req: NextApiRequest, res: NextApiResponse) {
+ const { ipAddress, userAgent } = extractRequestMetadata(req);
+
+ return await NextAuth(req, res, {
+ ...NEXT_AUTH_OPTIONS,
+ pages: {
+ signIn: '/signin',
+ signOut: '/signout',
+ error: '/signin',
+ },
+ events: {
+ createUser: async ({ user }) => {
+ await prisma.userSecurityAuditLog.create({
+ data: {
+ userId: user.id,
+ ipAddress,
+ userAgent,
+ type: UserSecurityAuditLogType.ACCOUNT_CREATE,
+ },
+ });
+ },
+ signIn: async ({ user }) => {
+ await prisma.userSecurityAuditLog.create({
+ data: {
+ userId: user.id,
+ ipAddress,
+ userAgent,
+ type: UserSecurityAuditLogType.SIGN_IN,
+ },
+ });
+ },
+ signOut: async ({ token }) => {
+ const userId = typeof token.id === 'string' ? parseInt(token.id) : token.id;
+
+ if (isNaN(userId)) {
+ return;
+ }
+
+ await prisma.userSecurityAuditLog.create({
+ data: {
+ userId,
+ ipAddress,
+ userAgent,
+ type: UserSecurityAuditLogType.SIGN_OUT,
+ },
+ });
+ },
+ linkAccount: async ({ user }) => {
+ const userId = typeof user.id === 'string' ? parseInt(user.id) : user.id;
+
+ if (isNaN(userId)) {
+ return;
+ }
-export default NextAuth({
- ...NEXT_AUTH_OPTIONS,
- pages: {
- signIn: '/signin',
- signOut: '/signout',
- error: '/signin',
- },
-});
-
-// export default async function handler(_req: NextApiRequest, res: NextApiResponse) {
-// res.json({ hello: 'world' });
-// }
+ await prisma.userSecurityAuditLog.create({
+ data: {
+ userId,
+ ipAddress,
+ userAgent,
+ type: UserSecurityAuditLogType.ACCOUNT_SSO_LINK,
+ },
+ });
+ },
+ },
+ });
+}
diff --git a/package-lock.json b/package-lock.json
index 69825e8d8..9012d3f29 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -158,6 +158,7 @@
"sharp": "0.33.1",
"ts-pattern": "^5.0.5",
"typescript": "5.2.2",
+ "ua-parser-js": "^1.0.37",
"uqr": "^0.1.2",
"zod": "^3.22.4"
},
@@ -166,7 +167,8 @@
"@types/luxon": "^3.3.1",
"@types/node": "20.1.0",
"@types/react": "18.2.18",
- "@types/react-dom": "18.2.7"
+ "@types/react-dom": "18.2.7",
+ "@types/ua-parser-js": "^0.7.39"
}
},
"apps/web/node_modules/@types/node": {
@@ -6756,6 +6758,12 @@
"resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.6.tgz",
"integrity": "sha512-dn1l8LaMea/IjDoHNd9J52uBbInB796CDffS6VdIxvqYCPSG0V0DzHp76GpaWnlhg88uYyPbXCDIowa86ybd5A=="
},
+ "node_modules/@types/ua-parser-js": {
+ "version": "0.7.39",
+ "resolved": "https://registry.npmjs.org/@types/ua-parser-js/-/ua-parser-js-0.7.39.tgz",
+ "integrity": "sha512-P/oDfpofrdtF5xw433SPALpdSchtJmY7nsJItf8h3KXqOslkbySh8zq4dSWXH2oTjRvJ5PczVEoCZPow6GicLg==",
+ "dev": true
+ },
"node_modules/@types/unist": {
"version": "2.0.10",
"resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.10.tgz",
@@ -18643,6 +18651,28 @@
"node": ">=14.17"
}
},
+ "node_modules/ua-parser-js": {
+ "version": "1.0.37",
+ "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-1.0.37.tgz",
+ "integrity": "sha512-bhTyI94tZofjo+Dn8SN6Zv8nBDvyXTymAdM3LDI/0IboIUwTu1rEhW7v2TfiVsoYWgkQ4kOVqnI8APUFbIQIFQ==",
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/ua-parser-js"
+ },
+ {
+ "type": "paypal",
+ "url": "https://paypal.me/faisalman"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/faisalman"
+ }
+ ],
+ "engines": {
+ "node": "*"
+ }
+ },
"node_modules/unbox-primitive": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz",
diff --git a/packages/lib/constants/auth.ts b/packages/lib/constants/auth.ts
index 837ca3e3a..48f1e9d7b 100644
--- a/packages/lib/constants/auth.ts
+++ b/packages/lib/constants/auth.ts
@@ -1,4 +1,4 @@
-import { IdentityProvider } from '@documenso/prisma/client';
+import { IdentityProvider, UserSecurityAuditLogType } from '@documenso/prisma/client';
export const SALT_ROUNDS = 12;
@@ -10,3 +10,15 @@ export const IDENTITY_PROVIDER_NAME: { [key in IdentityProvider]: string } = {
export const IS_GOOGLE_SSO_ENABLED = Boolean(
process.env.NEXT_PRIVATE_GOOGLE_CLIENT_ID && process.env.NEXT_PRIVATE_GOOGLE_CLIENT_SECRET,
);
+
+export const USER_SECURITY_AUDIT_LOG_MAP: { [key in UserSecurityAuditLogType]: string } = {
+ [UserSecurityAuditLogType.ACCOUNT_CREATE]: 'Account created',
+ [UserSecurityAuditLogType.ACCOUNT_SSO_LINK]: 'Linked account to SSO',
+ [UserSecurityAuditLogType.ACCOUNT_PROFILE_UPDATE]: 'Profile updated',
+ [UserSecurityAuditLogType.AUTH_2FA_DISABLE]: '2FA Disabled',
+ [UserSecurityAuditLogType.AUTH_2FA_ENABLE]: '2FA Enabled',
+ [UserSecurityAuditLogType.PASSWORD_RESET]: 'Password reset',
+ [UserSecurityAuditLogType.PASSWORD_UPDATE]: 'Password updated',
+ [UserSecurityAuditLogType.SIGN_IN]: 'Signed In',
+ [UserSecurityAuditLogType.SIGN_OUT]: 'Signed Out',
+};
diff --git a/packages/lib/next-auth/auth-options.ts b/packages/lib/next-auth/auth-options.ts
index 50240174c..9babae987 100644
--- a/packages/lib/next-auth/auth-options.ts
+++ b/packages/lib/next-auth/auth-options.ts
@@ -192,4 +192,5 @@ export const NEXT_AUTH_OPTIONS: AuthOptions = {
return true;
},
},
+ // Note: `events` are handled in `apps/web/src/pages/api/auth/[...nextauth].ts` to allow access to the request.
};
diff --git a/packages/lib/server-only/2fa/disable-2fa.ts b/packages/lib/server-only/2fa/disable-2fa.ts
index 5b27d5c9d..dd8a180c9 100644
--- a/packages/lib/server-only/2fa/disable-2fa.ts
+++ b/packages/lib/server-only/2fa/disable-2fa.ts
@@ -1,21 +1,25 @@
import { compare } from 'bcrypt';
import { prisma } from '@documenso/prisma';
-import { User } from '@documenso/prisma/client';
+import type { User } from '@documenso/prisma/client';
+import { UserSecurityAuditLogType } from '@documenso/prisma/client';
import { ErrorCode } from '../../next-auth/error-codes';
+import type { RequestMetadata } from '../../universal/extract-request-metadata';
import { validateTwoFactorAuthentication } from './validate-2fa';
type DisableTwoFactorAuthenticationOptions = {
user: User;
backupCode: string;
password: string;
+ requestMetadata?: RequestMetadata;
};
export const disableTwoFactorAuthentication = async ({
backupCode,
user,
password,
+ requestMetadata,
}: DisableTwoFactorAuthenticationOptions) => {
if (!user.password) {
throw new Error(ErrorCode.USER_MISSING_PASSWORD);
@@ -33,15 +37,26 @@ export const disableTwoFactorAuthentication = async ({
throw new Error(ErrorCode.INCORRECT_TWO_FACTOR_BACKUP_CODE);
}
- await prisma.user.update({
- where: {
- id: user.id,
- },
- data: {
- twoFactorEnabled: false,
- twoFactorBackupCodes: null,
- twoFactorSecret: null,
- },
+ await prisma.$transaction(async (tx) => {
+ await tx.user.update({
+ where: {
+ id: user.id,
+ },
+ data: {
+ twoFactorEnabled: false,
+ twoFactorBackupCodes: null,
+ twoFactorSecret: null,
+ },
+ });
+
+ await tx.userSecurityAuditLog.create({
+ data: {
+ userId: user.id,
+ type: UserSecurityAuditLogType.AUTH_2FA_DISABLE,
+ userAgent: requestMetadata?.userAgent,
+ ipAddress: requestMetadata?.ipAddress,
+ },
+ });
});
return true;
diff --git a/packages/lib/server-only/2fa/enable-2fa.ts b/packages/lib/server-only/2fa/enable-2fa.ts
index 9f61e52a4..19a2b67c2 100644
--- a/packages/lib/server-only/2fa/enable-2fa.ts
+++ b/packages/lib/server-only/2fa/enable-2fa.ts
@@ -1,18 +1,21 @@
import { ErrorCode } from '@documenso/lib/next-auth/error-codes';
import { prisma } from '@documenso/prisma';
-import { User } from '@documenso/prisma/client';
+import { type User, UserSecurityAuditLogType } from '@documenso/prisma/client';
+import type { RequestMetadata } from '../../universal/extract-request-metadata';
import { getBackupCodes } from './get-backup-code';
import { verifyTwoFactorAuthenticationToken } from './verify-2fa-token';
type EnableTwoFactorAuthenticationOptions = {
user: User;
code: string;
+ requestMetadata?: RequestMetadata;
};
export const enableTwoFactorAuthentication = async ({
user,
code,
+ requestMetadata,
}: EnableTwoFactorAuthenticationOptions) => {
if (user.identityProvider !== 'DOCUMENSO') {
throw new Error(ErrorCode.INCORRECT_IDENTITY_PROVIDER);
@@ -32,13 +35,24 @@ export const enableTwoFactorAuthentication = async ({
throw new Error(ErrorCode.INCORRECT_TWO_FACTOR_CODE);
}
- const updatedUser = await prisma.user.update({
- where: {
- id: user.id,
- },
- data: {
- twoFactorEnabled: true,
- },
+ const updatedUser = await prisma.$transaction(async (tx) => {
+ await tx.userSecurityAuditLog.create({
+ data: {
+ userId: user.id,
+ type: UserSecurityAuditLogType.AUTH_2FA_ENABLE,
+ userAgent: requestMetadata?.userAgent,
+ ipAddress: requestMetadata?.ipAddress,
+ },
+ });
+
+ return await tx.user.update({
+ where: {
+ id: user.id,
+ },
+ data: {
+ twoFactorEnabled: true,
+ },
+ });
});
const recoveryCodes = getBackupCodes({ user: updatedUser });
diff --git a/packages/lib/server-only/2fa/setup-2fa.ts b/packages/lib/server-only/2fa/setup-2fa.ts
index 30ddf0ec3..23f213574 100644
--- a/packages/lib/server-only/2fa/setup-2fa.ts
+++ b/packages/lib/server-only/2fa/setup-2fa.ts
@@ -5,7 +5,7 @@ import { createTOTPKeyURI } from 'oslo/otp';
import { ErrorCode } from '@documenso/lib/next-auth/error-codes';
import { prisma } from '@documenso/prisma';
-import { User } from '@documenso/prisma/client';
+import { type User } from '@documenso/prisma/client';
import { DOCUMENSO_ENCRYPTION_KEY } from '../../constants/crypto';
import { symmetricEncrypt } from '../../universal/crypto';
diff --git a/packages/lib/server-only/user/find-user-security-audit-logs.ts b/packages/lib/server-only/user/find-user-security-audit-logs.ts
new file mode 100644
index 000000000..0d6b5c8d5
--- /dev/null
+++ b/packages/lib/server-only/user/find-user-security-audit-logs.ts
@@ -0,0 +1,52 @@
+import type { FindResultSet } from '@documenso/lib/types/find-result-set';
+import { prisma } from '@documenso/prisma';
+import type { UserSecurityAuditLog, UserSecurityAuditLogType } from '@documenso/prisma/client';
+
+export type FindUserSecurityAuditLogsOptions = {
+ userId: number;
+ type?: UserSecurityAuditLogType;
+ page?: number;
+ perPage?: number;
+ orderBy?: {
+ column: keyof Omit<UserSecurityAuditLog, 'id' | 'userId'>;
+ direction: 'asc' | 'desc';
+ };
+};
+
+export const findUserSecurityAuditLogs = async ({
+ userId,
+ type,
+ page = 1,
+ perPage = 10,
+ orderBy,
+}: FindUserSecurityAuditLogsOptions) => {
+ const orderByColumn = orderBy?.column ?? 'createdAt';
+ const orderByDirection = orderBy?.direction ?? 'desc';
+
+ const whereClause = {
+ userId,
+ type,
+ };
+
+ const [data, count] = await Promise.all([
+ prisma.userSecurityAuditLog.findMany({
+ where: whereClause,
+ skip: Math.max(page - 1, 0) * perPage,
+ take: perPage,
+ orderBy: {
+ [orderByColumn]: orderByDirection,
+ },
+ }),
+ prisma.userSecurityAuditLog.count({
+ where: whereClause,
+ }),
+ ]);
+
+ return {
+ data,
+ count,
+ currentPage: Math.max(page, 1),
+ perPage,
+ totalPages: Math.ceil(count / perPage),
+ } satisfies FindResultSet<typeof data>;
+};
diff --git a/packages/lib/server-only/user/reset-password.ts b/packages/lib/server-only/user/reset-password.ts
index 2233894d8..39aac5d28 100644
--- a/packages/lib/server-only/user/reset-password.ts
+++ b/packages/lib/server-only/user/reset-password.ts
@@ -1,16 +1,19 @@
import { compare, hash } from 'bcrypt';
import { prisma } from '@documenso/prisma';
+import { UserSecurityAuditLogType } from '@documenso/prisma/client';
import { SALT_ROUNDS } from '../../constants/auth';
+import type { RequestMetadata } from '../../universal/extract-request-metadata';
import { sendResetPassword } from '../auth/send-reset-password';
export type ResetPasswordOptions = {
token: string;
password: string;
+ requestMetadata?: RequestMetadata;
};
-export const resetPassword = async ({ token, password }: ResetPasswordOptions) => {
+export const resetPassword = async ({ token, password, requestMetadata }: ResetPasswordOptions) => {
if (!token) {
throw new Error('Invalid token provided. Please try again.');
}
@@ -56,6 +59,14 @@ export const resetPassword = async ({ token, password }: ResetPasswordOptions) =
userId: foundToken.userId,
},
}),
+ prisma.userSecurityAuditLog.create({
+ data: {
+ userId: foundToken.userId,
+ type: UserSecurityAuditLogType.PASSWORD_RESET,
+ userAgent: requestMetadata?.userAgent,
+ ipAddress: requestMetadata?.ipAddress,
+ },
+ }),
]);
await sendResetPassword({ userId: foundToken.userId });
diff --git a/packages/lib/server-only/user/update-password.ts b/packages/lib/server-only/user/update-password.ts
index b7579cd35..2621fe8e3 100644
--- a/packages/lib/server-only/user/update-password.ts
+++ b/packages/lib/server-only/user/update-password.ts
@@ -1,19 +1,22 @@
import { compare, hash } from 'bcrypt';
+import { SALT_ROUNDS } from '@documenso/lib/constants/auth';
+import type { RequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
import { prisma } from '@documenso/prisma';
-
-import { SALT_ROUNDS } from '../../constants/auth';
+import { UserSecurityAuditLogType } from '@documenso/prisma/client';
export type UpdatePasswordOptions = {
userId: number;
password: string;
currentPassword: string;
+ requestMetadata?: RequestMetadata;
};
export const updatePassword = async ({
userId,
password,
currentPassword,
+ requestMetadata,
}: UpdatePasswordOptions) => {
// Existence check
const user = await prisma.user.findFirstOrThrow({
@@ -39,14 +42,23 @@ export const updatePassword = async ({
const hashedNewPassword = await hash(password, SALT_ROUNDS);
- const updatedUser = await prisma.user.update({
- where: {
- id: userId,
- },
- data: {
- password: hashedNewPassword,
- },
- });
+ return await prisma.$transaction(async (tx) => {
+ await tx.userSecurityAuditLog.create({
+ data: {
+ userId,
+ type: UserSecurityAuditLogType.PASSWORD_UPDATE,
+ userAgent: requestMetadata?.userAgent,
+ ipAddress: requestMetadata?.ipAddress,
+ },
+ });
- return updatedUser;
+ return await tx.user.update({
+ where: {
+ id: userId,
+ },
+ data: {
+ password: hashedNewPassword,
+ },
+ });
+ });
};
diff --git a/packages/lib/server-only/user/update-profile.ts b/packages/lib/server-only/user/update-profile.ts
index a28fd21c5..a99caff99 100644
--- a/packages/lib/server-only/user/update-profile.ts
+++ b/packages/lib/server-only/user/update-profile.ts
@@ -1,12 +1,21 @@
import { prisma } from '@documenso/prisma';
+import { UserSecurityAuditLogType } from '@documenso/prisma/client';
+
+import type { RequestMetadata } from '../../universal/extract-request-metadata';
export type UpdateProfileOptions = {
userId: number;
name: string;
signature: string;
+ requestMetadata?: RequestMetadata;
};
-export const updateProfile = async ({ userId, name, signature }: UpdateProfileOptions) => {
+export const updateProfile = async ({
+ userId,
+ name,
+ signature,
+ requestMetadata,
+}: UpdateProfileOptions) => {
// Existence check
await prisma.user.findFirstOrThrow({
where: {
@@ -14,15 +23,24 @@ export const updateProfile = async ({ userId, name, signature }: UpdateProfileOp
},
});
- const updatedUser = await prisma.user.update({
- where: {
- id: userId,
- },
- data: {
- name,
- signature,
- },
- });
+ return await prisma.$transaction(async (tx) => {
+ await tx.userSecurityAuditLog.create({
+ data: {
+ userId,
+ type: UserSecurityAuditLogType.ACCOUNT_PROFILE_UPDATE,
+ userAgent: requestMetadata?.userAgent,
+ ipAddress: requestMetadata?.ipAddress,
+ },
+ });
- return updatedUser;
+ return await tx.user.update({
+ where: {
+ id: userId,
+ },
+ data: {
+ name,
+ signature,
+ },
+ });
+ });
};
diff --git a/packages/lib/types/search-params.ts b/packages/lib/types/search-params.ts
new file mode 100644
index 000000000..ff3fdc4e2
--- /dev/null
+++ b/packages/lib/types/search-params.ts
@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+export const ZBaseTableSearchParamsSchema = z.object({
+ query: z
+ .string()
+ .optional()
+ .catch(() => undefined),
+ page: z.coerce
+ .number()
+ .min(1)
+ .optional()
+ .catch(() => undefined),
+ perPage: z.coerce
+ .number()
+ .min(1)
+ .optional()
+ .catch(() => undefined),
+});
+
+export type TBaseTableSearchParamsSchema = z.infer<typeof ZBaseTableSearchParamsSchema>;
diff --git a/packages/lib/universal/extract-request-metadata.ts b/packages/lib/universal/extract-request-metadata.ts
new file mode 100644
index 000000000..ceb4ad35f
--- /dev/null
+++ b/packages/lib/universal/extract-request-metadata.ts
@@ -0,0 +1,22 @@
+import type { NextApiRequest } from 'next';
+
+import { z } from 'zod';
+
+const ZIpSchema = z.string().ip();
+
+export type RequestMetadata = {
+ ipAddress?: string;
+ userAgent?: string;
+};
+
+export const extractRequestMetadata = (req: NextApiRequest): RequestMetadata => {
+ const parsedIp = ZIpSchema.safeParse(req.headers['x-forwarded-for'] || req.socket.remoteAddress);
+
+ const ipAddress = parsedIp.success ? parsedIp.data : undefined;
+ const userAgent = req.headers['user-agent'];
+
+ return {
+ ipAddress,
+ userAgent,
+ };
+};
diff --git a/packages/prisma/migrations/20240130062658_add_user_security_audit_logs/migration.sql b/packages/prisma/migrations/20240130062658_add_user_security_audit_logs/migration.sql
new file mode 100644
index 000000000..73d85ada8
--- /dev/null
+++ b/packages/prisma/migrations/20240130062658_add_user_security_audit_logs/migration.sql
@@ -0,0 +1,17 @@
+-- CreateEnum
+CREATE TYPE "UserSecurityAuditLogType" AS ENUM ('ACCOUNT_CREATE', 'ACCOUNT_PROFILE_UPDATE', 'ACCOUNT_SSO_LINK', 'AUTH_2FA_DISABLE', 'AUTH_2FA_ENABLE', 'PASSWORD_RESET', 'PASSWORD_UPDATE', 'SIGN_OUT', 'SIGN_IN');
+
+-- CreateTable
+CREATE TABLE "UserSecurityAuditLog" (
+ "id" SERIAL NOT NULL,
+ "userId" INTEGER NOT NULL,
+ "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ "type" "UserSecurityAuditLogType" NOT NULL,
+ "userAgent" TEXT,
+ "ipAddress" TEXT,
+
+ CONSTRAINT "UserSecurityAuditLog_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "UserSecurityAuditLog" ADD CONSTRAINT "UserSecurityAuditLog_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
diff --git a/packages/prisma/schema.prisma b/packages/prisma/schema.prisma
index e1549e072..8f83f0ac3 100644
--- a/packages/prisma/schema.prisma
+++ b/packages/prisma/schema.prisma
@@ -40,12 +40,37 @@ model User {
twoFactorSecret String?
twoFactorEnabled Boolean @default(false)
twoFactorBackupCodes String?
- VerificationToken VerificationToken[]
- Template Template[]
+
+ VerificationToken VerificationToken[]
+ Template Template[]
+ securityAuditLogs UserSecurityAuditLog[]
@@index([email])
}
+enum UserSecurityAuditLogType {
+ ACCOUNT_CREATE
+ ACCOUNT_PROFILE_UPDATE
+ ACCOUNT_SSO_LINK
+ AUTH_2FA_DISABLE
+ AUTH_2FA_ENABLE
+ PASSWORD_RESET
+ PASSWORD_UPDATE
+ SIGN_OUT
+ SIGN_IN
+}
+
+model UserSecurityAuditLog {
+ id Int @id @default(autoincrement())
+ userId Int
+ createdAt DateTime @default(now())
+ type UserSecurityAuditLogType
+ userAgent String?
+ ipAddress String?
+
+ User User @relation(fields: [userId], references: [id])
+}
+
model PasswordResetToken {
id Int @id @default(autoincrement())
token String @unique
@@ -161,9 +186,9 @@ model DocumentMeta {
id String @id @default(cuid())
subject String?
message String?
- timezone String? @db.Text @default("Etc/UTC")
- password String?
- dateFormat String? @db.Text @default("yyyy-MM-dd hh:mm a")
+ timezone String? @default("Etc/UTC") @db.Text
+ password String?
+ dateFormat String? @default("yyyy-MM-dd hh:mm a") @db.Text
documentId Int @unique
document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)
}
@@ -184,19 +209,19 @@ enum SigningStatus {
}
model Recipient {
- id Int @id @default(autoincrement())
+ id Int @id @default(autoincrement())
documentId Int?
templateId Int?
- email String @db.VarChar(255)
- name String @default("") @db.VarChar(255)
+ email String @db.VarChar(255)
+ name String @default("") @db.VarChar(255)
token String
expired DateTime?
signedAt DateTime?
readStatus ReadStatus @default(NOT_OPENED)
signingStatus SigningStatus @default(NOT_SIGNED)
sendStatus SendStatus @default(NOT_SENT)
- Document Document? @relation(fields: [documentId], references: [id], onDelete: Cascade)
- Template Template? @relation(fields: [templateId], references: [id], onDelete: Cascade)
+ Document Document? @relation(fields: [documentId], references: [id], onDelete: Cascade)
+ Template Template? @relation(fields: [templateId], references: [id], onDelete: Cascade)
Field Field[]
Signature Signature[]
@@ -280,10 +305,10 @@ model Template {
createdAt DateTime @default(now())
updatedAt DateTime @default(now()) @updatedAt
- templateDocumentData DocumentData @relation(fields: [templateDocumentDataId], references: [id], onDelete: Cascade)
- User User @relation(fields: [userId], references: [id], onDelete: Cascade)
- Recipient Recipient[]
- Field Field[]
+ templateDocumentData DocumentData @relation(fields: [templateDocumentDataId], references: [id], onDelete: Cascade)
+ User User @relation(fields: [userId], references: [id], onDelete: Cascade)
+ Recipient Recipient[]
+ Field Field[]
@@unique([templateDocumentDataId])
}
diff --git a/packages/trpc/server/context.ts b/packages/trpc/server/context.ts
index e1973f08b..7136afd70 100644
--- a/packages/trpc/server/context.ts
+++ b/packages/trpc/server/context.ts
@@ -1,4 +1,4 @@
-import { CreateNextContextOptions } from '@trpc/server/adapters/next';
+import type { CreateNextContextOptions } from '@trpc/server/adapters/next';
import { getServerSession } from '@documenso/lib/next-auth/get-server-session';
@@ -9,6 +9,7 @@ export const createTrpcContext = async ({ req, res }: CreateNextContextOptions)
return {
session: null,
user: null,
+ req,
};
}
@@ -16,12 +17,14 @@ export const createTrpcContext = async ({ req, res }: CreateNextContextOptions)
return {
session: null,
user: null,
+ req,
};
}
return {
session,
user,
+ req,
};
};
diff --git a/packages/trpc/server/profile-router/router.ts b/packages/trpc/server/profile-router/router.ts
index 4dcf4ca93..c595c628c 100644
--- a/packages/trpc/server/profile-router/router.ts
+++ b/packages/trpc/server/profile-router/router.ts
@@ -1,15 +1,18 @@
import { TRPCError } from '@trpc/server';
+import { findUserSecurityAuditLogs } from '@documenso/lib/server-only/user/find-user-security-audit-logs';
import { forgotPassword } from '@documenso/lib/server-only/user/forgot-password';
import { getUserById } from '@documenso/lib/server-only/user/get-user-by-id';
import { resetPassword } from '@documenso/lib/server-only/user/reset-password';
import { sendConfirmationToken } from '@documenso/lib/server-only/user/send-confirmation-token';
import { updatePassword } from '@documenso/lib/server-only/user/update-password';
import { updateProfile } from '@documenso/lib/server-only/user/update-profile';
+import { extractRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
import { adminProcedure, authenticatedProcedure, procedure, router } from '../trpc';
import {
ZConfirmEmailMutationSchema,
+ ZFindUserSecurityAuditLogsSchema,
ZForgotPasswordFormSchema,
ZResetPasswordFormSchema,
ZRetrieveUserByIdQuerySchema,
@@ -18,6 +21,22 @@ import {
} from './schema';
export const profileRouter = router({
+ findUserSecurityAuditLogs: authenticatedProcedure
+ .input(ZFindUserSecurityAuditLogsSchema)
+ .query(async ({ input, ctx }) => {
+ try {
+ return await findUserSecurityAuditLogs({
+ userId: ctx.user.id,
+ ...input,
+ });
+ } catch (err) {
+ throw new TRPCError({
+ code: 'BAD_REQUEST',
+ message: 'We were unable to find user security audit logs. Please try again.',
+ });
+ }
+ }),
+
getUser: adminProcedure.input(ZRetrieveUserByIdQuerySchema).query(async ({ input }) => {
try {
const { id } = input;
@@ -41,6 +60,7 @@ export const profileRouter = router({
userId: ctx.user.id,
name,
signature,
+ requestMetadata: extractRequestMetadata(ctx.req),
});
} catch (err) {
console.error(err);
@@ -63,6 +83,7 @@ export const profileRouter = router({
userId: ctx.user.id,
password,
currentPassword,
+ requestMetadata: extractRequestMetadata(ctx.req),
});
} catch (err) {
let message =
@@ -91,13 +112,14 @@ export const profileRouter = router({
}
}),
- resetPassword: procedure.input(ZResetPasswordFormSchema).mutation(async ({ input }) => {
+ resetPassword: procedure.input(ZResetPasswordFormSchema).mutation(async ({ input, ctx }) => {
try {
const { password, token } = input;
return await resetPassword({
token,
password,
+ requestMetadata: extractRequestMetadata(ctx.req),
});
} catch (err) {
let message = 'We were unable to reset your password. Please try again.';
diff --git a/packages/trpc/server/profile-router/schema.ts b/packages/trpc/server/profile-router/schema.ts
index 1d6820007..522b13552 100644
--- a/packages/trpc/server/profile-router/schema.ts
+++ b/packages/trpc/server/profile-router/schema.ts
@@ -2,6 +2,11 @@ import { z } from 'zod';
import { ZCurrentPasswordSchema, ZPasswordSchema } from '../auth-router/schema';
+export const ZFindUserSecurityAuditLogsSchema = z.object({
+ page: z.number().optional(),
+ perPage: z.number().optional(),
+});
+
export const ZRetrieveUserByIdQuerySchema = z.object({
id: z.number().min(1),
});
@@ -29,6 +34,7 @@ export const ZConfirmEmailMutationSchema = z.object({
email: z.string().email().min(1),
});
+export type TFindUserSecurityAuditLogsSchema = z.infer<typeof ZFindUserSecurityAuditLogsSchema>;
export type TRetrieveUserByIdQuerySchema = z.infer<typeof ZRetrieveUserByIdQuerySchema>;
export type TUpdateProfileMutationSchema = z.infer<typeof ZUpdateProfileMutationSchema>;
export type TUpdatePasswordMutationSchema = z.infer<typeof ZUpdatePasswordMutationSchema>;
diff --git a/packages/trpc/server/two-factor-authentication-router/router.ts b/packages/trpc/server/two-factor-authentication-router/router.ts
index a10f7a543..b499de703 100644
--- a/packages/trpc/server/two-factor-authentication-router/router.ts
+++ b/packages/trpc/server/two-factor-authentication-router/router.ts
@@ -6,6 +6,7 @@ import { enableTwoFactorAuthentication } from '@documenso/lib/server-only/2fa/en
import { getBackupCodes } from '@documenso/lib/server-only/2fa/get-backup-code';
import { setupTwoFactorAuthentication } from '@documenso/lib/server-only/2fa/setup-2fa';
import { compareSync } from '@documenso/lib/server-only/auth/hash';
+import { extractRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
import { authenticatedProcedure, router } from '../trpc';
import {
@@ -23,7 +24,10 @@ export const twoFactorAuthenticationRouter = router({
const { password } = input;
- return await setupTwoFactorAuthentication({ user, password });
+ return await setupTwoFactorAuthentication({
+ user,
+ password,
+ });
}),
enable: authenticatedProcedure
@@ -34,7 +38,11 @@ export const twoFactorAuthenticationRouter = router({
const { code } = input;
- return await enableTwoFactorAuthentication({ user, code });
+ return await enableTwoFactorAuthentication({
+ user,
+ code,
+ requestMetadata: extractRequestMetadata(ctx.req),
+ });
} catch (err) {
console.error(err);
@@ -53,7 +61,12 @@ export const twoFactorAuthenticationRouter = router({
const { password, backupCode } = input;
- return await disableTwoFactorAuthentication({ user, password, backupCode });
+ return await disableTwoFactorAuthentication({
+ user,
+ password,
+ backupCode,
+ requestMetadata: extractRequestMetadata(ctx.req),
+ });
} catch (err) {
console.error(err);
diff --git a/packages/ui/primitives/alert.tsx b/packages/ui/primitives/alert.tsx
index 190f7781d..092fbb2b4 100644
--- a/packages/ui/primitives/alert.tsx
+++ b/packages/ui/primitives/alert.tsx
@@ -1,21 +1,33 @@
import * as React from 'react';
-import { VariantProps, cva } from 'class-variance-authority';
+import type { VariantProps } from 'class-variance-authority';
+import { cva } from 'class-variance-authority';
import { cn } from '../lib/utils';
const alertVariants = cva(
- 'relative w-full rounded-lg border p-4 [&>svg]:absolute [&>svg]:text-foreground [&>svg]:left-4 [&>svg]:top-4 [&>svg+div]:translate-y-[-3px] [&:has(svg)]:pl-11',
+ 'relative w-full rounded-lg p-4 [&>svg]:absolute [&>svg]:text-foreground [&>svg]:left-4 [&>svg]:top-4 [&>svg+div]:translate-y-[-3px] [&>svg~*]:pl-8',
{
variants: {
variant: {
- default: 'bg-background text-foreground',
- destructive:
- 'text-destructive border-destructive/50 dark:border-destructive [&>svg]:text-destructive text-destructive',
+ default:
+ 'bg-green-50 text-green-700 [&_.alert-title]:text-green-800 [&>svg]:text-green-400',
+ neutral:
+ 'bg-gray-50 dark:bg-neutral-900/20 text-muted-foreground [&_.alert-title]:text-foreground',
+ secondary: 'bg-blue-50 text-blue-700 [&_.alert-title]:text-blue-800 [&>svg]:text-blue-400',
+ destructive: 'bg-red-50 text-red-700 [&_.alert-title]:text-red-800 [&>svg]:text-red-400',
+ warning:
+ 'bg-yellow-50 text-yellow-700 [&_.alert-title]:text-yellow-800 [&>svg]:text-yellow-400',
+ },
+ padding: {
+ tighter: 'p-2',
+ tight: 'px-4 py-2',
+ default: 'p-4',
},
},
defaultVariants: {
variant: 'default',
+ padding: 'default',
},
},
);
@@ -23,19 +35,20 @@ const alertVariants = cva(
const Alert = React.forwardRef<
HTMLDivElement,
React.HTMLAttributes<HTMLDivElement> & VariantProps<typeof alertVariants>
->(({ className, variant, ...props }, ref) => (
- <div ref={ref} role="alert" className={cn(alertVariants({ variant }), className)} {...props} />
+>(({ className, variant, padding, ...props }, ref) => (
+ <div
+ ref={ref}
+ role="alert"
+ className={cn(alertVariants({ variant, padding }), className)}
+ {...props}
+ />
));
Alert.displayName = 'Alert';
const AlertTitle = React.forwardRef<HTMLParagraphElement, React.HTMLAttributes<HTMLHeadingElement>>(
({ className, ...props }, ref) => (
- <h5
- ref={ref}
- className={cn('mb-1 font-medium leading-none tracking-tight', className)}
- {...props}
- />
+ <h5 ref={ref} className={cn('alert-title text-base font-medium', className)} {...props} />
),
);
@@ -45,7 +58,7 @@ const AlertDescription = React.forwardRef<
HTMLParagraphElement,
React.HTMLAttributes<HTMLParagraphElement>
>(({ className, ...props }, ref) => (
- <div ref={ref} className={cn('text-sm [&_p]:leading-relaxed', className)} {...props} />
+ <div ref={ref} className={cn('text-sm', className)} {...props} />
));
AlertDescription.displayName = 'AlertDescription';
diff --git a/packages/ui/primitives/data-table.tsx b/packages/ui/primitives/data-table.tsx
index e4a89e141..9cc14a684 100644
--- a/packages/ui/primitives/data-table.tsx
+++ b/packages/ui/primitives/data-table.tsx
@@ -2,36 +2,53 @@
import React, { useMemo } from 'react';
-import {
+import type {
ColumnDef,
PaginationState,
Table as TTable,
Updater,
- flexRender,
- getCoreRowModel,
- useReactTable,
+ VisibilityState,
} from '@tanstack/react-table';
+import { flexRender, getCoreRowModel, useReactTable } from '@tanstack/react-table';
+import { Skeleton } from './skeleton';
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from './table';
export type DataTableChildren<TData> = (_table: TTable<TData>) => React.ReactNode;
export interface DataTableProps<TData, TValue> {
columns: ColumnDef<TData, TValue>[];
+ columnVisibility?: VisibilityState;
data: TData[];
perPage?: number;
currentPage?: number;
totalPages?: number;
onPaginationChange?: (_page: number, _perPage: number) => void;
+ onClearFilters?: () => void;
+ hasFilters?: boolean;
children?: DataTableChildren<TData>;
+ skeleton?: {
+ enable: boolean;
+ rows: number;
+ component?: React.ReactNode;
+ };
+ error?: {
+ enable: boolean;
+ component?: React.ReactNode;
+ };
}
export function DataTable<TData, TValue>({
columns,
+ columnVisibility,
data,
+ error,
perPage,
currentPage,
totalPages,
+ skeleton,
+ hasFilters,
+ onClearFilters,
onPaginationChange,
children,
}: DataTableProps<TData, TValue>) {
@@ -67,6 +84,7 @@ export function DataTable<TData, TValue>({
getCoreRowModel: getCoreRowModel(),
state: {
pagination: manualPagination ? pagination : undefined,
+ columnVisibility,
},
manualPagination,
pageCount: totalPages,
@@ -103,10 +121,31 @@ export function DataTable<TData, TValue>({
))}
</TableRow>
))
+ ) : error?.enable ? (
+ <TableRow>
+ {error.component ?? (
+ <TableCell colSpan={columns.length} className="h-32 text-center">
+ Something went wrong.
+ </TableCell>
+ )}
+ </TableRow>
+ ) : skeleton?.enable ? (
+ Array.from({ length: skeleton.rows }).map((_, i) => (
+ <TableRow key={`skeleton-row-${i}`}>{skeleton.component ?? <Skeleton />}</TableRow>
+ ))
) : (
<TableRow>
- <TableCell colSpan={columns.length} className="h-24 text-center">
- No results.
+ <TableCell colSpan={columns.length} className="h-32 text-center">
+ <p>No results found</p>
+
+ {hasFilters && onClearFilters !== undefined && (
+ <button
+ onClick={() => onClearFilters()}
+ className="text-foreground mt-1 text-sm"
+ >
+ Clear filters
+ </button>
+ )}
</TableCell>
</TableRow>
)}