refactor: Encrypt & Expire User Provided Keys, feat: Rate Limiting (#874)
* docs: make_your_own.md formatting fix for mkdocs
* feat: add express-mongo-sanitize
feat: add login/registration rate limiting
* chore: remove unnecessary console log
* wip: remove token handling from localStorage to encrypted DB solution
* refactor: minor change to UserService
* fix mongo query and add keys route to server
* fix backend controllers and simplify schema/crud
* refactor: rename token to key to separate from access/refresh tokens, setTokenDialog -> setKeyDialog
* refactor(schemas): TEndpointOption token -> key
* refactor(api): use new encrypted key retrieval system
* fix(SetKeyDialog): fix key prop error
* fix(abortMiddleware): pass random UUID if messageId is not generated yet for proper error display on frontend
* fix(getUserKey): wrong prop passed in arg, adds error handling
* fix: prevent message without conversationId from saving to DB, prevents branching on the frontend to a new top-level branch
* refactor: change wording of multiple display messages
* refactor(checkExpiry -> checkUserKeyExpiry): move to UserService file
* fix: type imports from common
* refactor(SubmitButton): convert to TS
* refactor(key.ts): change localStorage map key name
* refactor: add new custom tailwind classes to better match openAI colors
* chore: remove unnecessary warning and catch ScreenShot error
* refactor: move userKey frontend logic to hooks and remove use of localStorage and instead query the DB
* refactor: invalidate correct query key, memoize userKey hook, conditionally render SetKeyDialog to avoid unnecessary calls, refactor SubmitButton props and useEffect for showing 'provide key first'
* fix(SetKeyDialog): use enum-like object for expiry values
feat(Dropdown): add optionsClassName to dynamically change dropdown options container classes
* fix: handle edge case where user had provided a key but the server changes to env variable for keys
* refactor(OpenAI/titleConvo): move titling to client to retain authorized credentials in message lifecycle for titling
* fix(azure): handle user_provided keys correctly for azure
* feat: send user Id to OpenAI to differentiate users in completion requests
* refactor(OpenAI/titleConvo): adding tokens helps minimize LLM from using the language in title response
* feat: add delete endpoint for keys
* chore: remove throttling of title
* feat: add 'Data controls' to Settings, add 'Revoke' keys feature in Key Dialog and Data controls
* refactor: reorganize PluginsClient files in langchain format
* feat: use langchain for titling convos
* chore: cleanup titling convo, with fallback to original method, escape braces, use only snippet for language detection
* refactor: move helper functions to appropriate langchain folders for reusability
* fix: userProvidesKey handling for gptPlugins
* fix: frontend handling of plugins key
* chore: cleanup logging and ts-ignore SSE
* fix: forwardRef misuse in DangerButton
* fix(GoogleConfig/FileUpload): localize errors and simplify validation with zod
* fix: cleanup google logging and fix user provided key handling
* chore: remove titling from google
* chore: removing logging from browser endpoint
* wip: fix menu flicker
* feat: useLocalStorage hook
* feat: add Tooltip for UI
* refactor(EndpointMenu): utilize Tooltip and useLocalStorage, remove old 'New Chat' slide-over
* fix(e2e): use testId for endpoint menu trigger
* chore: final touches to EndpointMenu before future refactor to declutter component
* refactor(localization): change select endpoint to open menu and add translations
* chore: add final prop to error message response
* ci: minor edits to facilitate testing
* ci: new e2e test which tests for new key setting/revoking features
2023-09-06 10:46:27 -04:00
|
|
|
import * as Tabs from '@radix-ui/react-tabs';
|
2023-12-11 14:48:40 -05:00
|
|
|
import {
|
|
|
|
|
useRevokeAllUserKeysMutation,
|
|
|
|
|
useRevokeUserKeyMutation,
|
|
|
|
|
} from 'librechat-data-provider/react-query';
|
refactor: Encrypt & Expire User Provided Keys, feat: Rate Limiting (#874)
* docs: make_your_own.md formatting fix for mkdocs
* feat: add express-mongo-sanitize
feat: add login/registration rate limiting
* chore: remove unnecessary console log
* wip: remove token handling from localStorage to encrypted DB solution
* refactor: minor change to UserService
* fix mongo query and add keys route to server
* fix backend controllers and simplify schema/crud
* refactor: rename token to key to separate from access/refresh tokens, setTokenDialog -> setKeyDialog
* refactor(schemas): TEndpointOption token -> key
* refactor(api): use new encrypted key retrieval system
* fix(SetKeyDialog): fix key prop error
* fix(abortMiddleware): pass random UUID if messageId is not generated yet for proper error display on frontend
* fix(getUserKey): wrong prop passed in arg, adds error handling
* fix: prevent message without conversationId from saving to DB, prevents branching on the frontend to a new top-level branch
* refactor: change wording of multiple display messages
* refactor(checkExpiry -> checkUserKeyExpiry): move to UserService file
* fix: type imports from common
* refactor(SubmitButton): convert to TS
* refactor(key.ts): change localStorage map key name
* refactor: add new custom tailwind classes to better match openAI colors
* chore: remove unnecessary warning and catch ScreenShot error
* refactor: move userKey frontend logic to hooks and remove use of localStorage and instead query the DB
* refactor: invalidate correct query key, memoize userKey hook, conditionally render SetKeyDialog to avoid unnecessary calls, refactor SubmitButton props and useEffect for showing 'provide key first'
* fix(SetKeyDialog): use enum-like object for expiry values
feat(Dropdown): add optionsClassName to dynamically change dropdown options container classes
* fix: handle edge case where user had provided a key but the server changes to env variable for keys
* refactor(OpenAI/titleConvo): move titling to client to retain authorized credentials in message lifecycle for titling
* fix(azure): handle user_provided keys correctly for azure
* feat: send user Id to OpenAI to differentiate users in completion requests
* refactor(OpenAI/titleConvo): adding tokens helps minimize LLM from using the language in title response
* feat: add delete endpoint for keys
* chore: remove throttling of title
* feat: add 'Data controls' to Settings, add 'Revoke' keys feature in Key Dialog and Data controls
* refactor: reorganize PluginsClient files in langchain format
* feat: use langchain for titling convos
* chore: cleanup titling convo, with fallback to original method, escape braces, use only snippet for language detection
* refactor: move helper functions to appropriate langchain folders for reusability
* fix: userProvidesKey handling for gptPlugins
* fix: frontend handling of plugins key
* chore: cleanup logging and ts-ignore SSE
* fix: forwardRef misuse in DangerButton
* fix(GoogleConfig/FileUpload): localize errors and simplify validation with zod
* fix: cleanup google logging and fix user provided key handling
* chore: remove titling from google
* chore: removing logging from browser endpoint
* wip: fix menu flicker
* feat: useLocalStorage hook
* feat: add Tooltip for UI
* refactor(EndpointMenu): utilize Tooltip and useLocalStorage, remove old 'New Chat' slide-over
* fix(e2e): use testId for endpoint menu trigger
* chore: final touches to EndpointMenu before future refactor to declutter component
* refactor(localization): change select endpoint to open menu and add translations
* chore: add final prop to error message response
* ci: minor edits to facilitate testing
* ci: new e2e test which tests for new key setting/revoking features
2023-09-06 10:46:27 -04:00
|
|
|
import React, { useState, useCallback, useRef } from 'react';
|
|
|
|
|
import { useOnClickOutside } from '~/hooks';
|
|
|
|
|
import DangerButton from './DangerButton';
|
|
|
|
|
|
|
|
|
|
export const RevokeKeysButton = ({
|
|
|
|
|
showText = true,
|
|
|
|
|
endpoint = '',
|
|
|
|
|
all = false,
|
|
|
|
|
disabled = false,
|
|
|
|
|
}: {
|
|
|
|
|
showText?: boolean;
|
|
|
|
|
endpoint?: string;
|
|
|
|
|
all?: boolean;
|
|
|
|
|
disabled?: boolean;
|
|
|
|
|
}) => {
|
|
|
|
|
const [confirmClear, setConfirmClear] = useState(false);
|
|
|
|
|
const revokeKeyMutation = useRevokeUserKeyMutation(endpoint);
|
|
|
|
|
const revokeKeysMutation = useRevokeAllUserKeysMutation();
|
|
|
|
|
|
|
|
|
|
const contentRef = useRef(null);
|
|
|
|
|
useOnClickOutside(contentRef, () => confirmClear && setConfirmClear(false), []);
|
|
|
|
|
|
|
|
|
|
const revokeAllUserKeys = useCallback(() => {
|
|
|
|
|
if (confirmClear) {
|
|
|
|
|
revokeKeysMutation.mutate({});
|
|
|
|
|
setConfirmClear(false);
|
|
|
|
|
} else {
|
|
|
|
|
setConfirmClear(true);
|
|
|
|
|
}
|
|
|
|
|
}, [confirmClear, revokeKeysMutation]);
|
|
|
|
|
|
|
|
|
|
const revokeUserKey = useCallback(() => {
|
|
|
|
|
if (!endpoint) {
|
|
|
|
|
return;
|
|
|
|
|
} else if (confirmClear) {
|
|
|
|
|
revokeKeyMutation.mutate({});
|
|
|
|
|
setConfirmClear(false);
|
|
|
|
|
} else {
|
|
|
|
|
setConfirmClear(true);
|
|
|
|
|
}
|
|
|
|
|
}, [confirmClear, revokeKeyMutation, endpoint]);
|
|
|
|
|
|
|
|
|
|
const onClick = all ? revokeAllUserKeys : revokeUserKey;
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<DangerButton
|
|
|
|
|
ref={contentRef}
|
|
|
|
|
showText={showText}
|
|
|
|
|
onClick={onClick}
|
|
|
|
|
disabled={disabled}
|
|
|
|
|
confirmClear={confirmClear}
|
|
|
|
|
id={'revoke-all-user-keys'}
|
|
|
|
|
actionTextCode={'com_ui_revoke'}
|
|
|
|
|
infoTextCode={'com_ui_revoke_info'}
|
|
|
|
|
dataTestIdInitial={'revoke-all-keys-initial'}
|
|
|
|
|
dataTestIdConfirm={'revoke-all-keys-confirm'}
|
|
|
|
|
mutation={all ? revokeKeysMutation : revokeKeyMutation}
|
|
|
|
|
/>
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
function Data() {
|
|
|
|
|
return (
|
|
|
|
|
<Tabs.Content value="data" role="tabpanel" className="w-full md:min-h-[300px]">
|
|
|
|
|
<div className="flex flex-col gap-3 text-sm text-gray-600 dark:text-gray-300">
|
|
|
|
|
<div className="border-b pb-3 last-of-type:border-b-0 dark:border-gray-700">
|
|
|
|
|
<RevokeKeysButton all={true} />
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</Tabs.Content>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export default React.memo(Data);
|