mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-09-21 23:55:23 +00:00
* Allow LDAP login via username This patch adds the option to login via username instead of using an email address since the latter may not be unique or may change. For example, our organization has two main domains and users have a log and a short form of their mail address. This makes it hard for users to identify what their primary email address is and causes a lot of confusion. Using their username instead makes it much easier. Using a username will also make it easier in the future to not need a separate bind user to get user attributes. So, this is also a bit of prep work for that. * Update config.js * feat: Enable LDAP login via username This commit enables the option to login via username instead of using an email address for LDAP authentication. This change is necessary because email addresses may not be unique or may change, causing confusion for users. By using usernames, it becomes easier for users to identify their primary email address. Additionally, this change prepares for future improvements by eliminating the need for a separate bind user to retrieve user attributes. Co-authored-by: Danny Avila <danny@librechat.ai> * chore: jsdocs * chore: import order * ci: add ldap config tests --------- Co-authored-by: Lars Kiesow <lkiesow@uos.de>
159 lines
6.5 KiB
TypeScript
159 lines
6.5 KiB
TypeScript
import { useForm } from 'react-hook-form';
|
|
import React, { useState, useEffect } from 'react';
|
|
import { useGetStartupConfig } from 'librechat-data-provider/react-query';
|
|
import type { TLoginUser, TStartupConfig } from 'librechat-data-provider';
|
|
import type { TAuthContext } from '~/common';
|
|
import { useResendVerificationEmail } from '~/data-provider';
|
|
import { useLocalize } from '~/hooks';
|
|
|
|
type TLoginFormProps = {
|
|
onSubmit: (data: TLoginUser) => void;
|
|
startupConfig: TStartupConfig;
|
|
error: Pick<TAuthContext, 'error'>['error'];
|
|
setError: Pick<TAuthContext, 'setError'>['setError'];
|
|
};
|
|
|
|
const LoginForm: React.FC<TLoginFormProps> = ({ onSubmit, startupConfig, error, setError }) => {
|
|
const localize = useLocalize();
|
|
const {
|
|
register,
|
|
getValues,
|
|
handleSubmit,
|
|
formState: { errors },
|
|
} = useForm<TLoginUser>();
|
|
const [showResendLink, setShowResendLink] = useState<boolean>(false);
|
|
|
|
const { data: config } = useGetStartupConfig();
|
|
const useUsernameLogin = config?.ldap?.username;
|
|
|
|
useEffect(() => {
|
|
if (error && error.includes('422') && !showResendLink) {
|
|
setShowResendLink(true);
|
|
}
|
|
}, [error, showResendLink]);
|
|
|
|
const resendLinkMutation = useResendVerificationEmail({
|
|
onMutate: () => {
|
|
setError(undefined);
|
|
setShowResendLink(false);
|
|
},
|
|
});
|
|
|
|
if (!startupConfig) {
|
|
return null;
|
|
}
|
|
|
|
const renderError = (fieldName: string) => {
|
|
const errorMessage = errors[fieldName]?.message;
|
|
return errorMessage ? (
|
|
<span role="alert" className="mt-1 text-sm text-red-500 dark:text-red-900">
|
|
{String(errorMessage)}
|
|
</span>
|
|
) : null;
|
|
};
|
|
|
|
const handleResendEmail = () => {
|
|
const email = getValues('email');
|
|
if (!email) {
|
|
return setShowResendLink(false);
|
|
}
|
|
resendLinkMutation.mutate({ email });
|
|
};
|
|
|
|
return (
|
|
<>
|
|
{showResendLink && (
|
|
<div className="mt-2 rounded-md border border-green-500 bg-green-500/10 px-3 py-2 text-sm text-gray-600 dark:text-gray-200">
|
|
{localize('com_auth_email_verification_resend_prompt')}
|
|
<button
|
|
type="button"
|
|
className="ml-2 text-blue-600 hover:underline"
|
|
onClick={handleResendEmail}
|
|
disabled={resendLinkMutation.isLoading}
|
|
>
|
|
{localize('com_auth_email_resend_link')}
|
|
</button>
|
|
</div>
|
|
)}
|
|
<form
|
|
className="mt-6"
|
|
aria-label="Login form"
|
|
method="POST"
|
|
onSubmit={handleSubmit((data) => onSubmit(data))}
|
|
>
|
|
<div className="mb-2">
|
|
<div className="relative">
|
|
<input
|
|
type="text"
|
|
id="email"
|
|
autoComplete={useUsernameLogin ? 'username' : 'email'}
|
|
aria-label={localize('com_auth_email')}
|
|
{...register('email', {
|
|
required: localize('com_auth_email_required'),
|
|
maxLength: { value: 120, message: localize('com_auth_email_max_length') },
|
|
pattern: {
|
|
value: useUsernameLogin ? /\S+/ : /\S+@\S+\.\S+/,
|
|
message: localize('com_auth_email_pattern'),
|
|
},
|
|
})}
|
|
aria-invalid={!!errors.email}
|
|
className="webkit-dark-styles peer block w-full appearance-none rounded-md border border-gray-300 bg-transparent px-3.5 pb-3.5 pt-4 text-sm text-gray-900 focus:border-green-500 focus:outline-none focus:ring-0 dark:border-gray-600 dark:text-white dark:focus:border-green-500"
|
|
placeholder=" "
|
|
/>
|
|
<label
|
|
htmlFor="email"
|
|
className="absolute start-1 top-2 z-10 origin-[0] -translate-y-4 scale-75 transform bg-white px-3 text-sm text-gray-500 duration-100 peer-placeholder-shown:top-1/2 peer-placeholder-shown:-translate-y-1/2 peer-placeholder-shown:scale-100 peer-focus:top-2 peer-focus:-translate-y-4 peer-focus:scale-75 peer-focus:px-3 peer-focus:text-green-600 dark:bg-gray-900 dark:text-gray-400 dark:peer-focus:text-green-500 rtl:peer-focus:left-auto rtl:peer-focus:translate-x-1/4"
|
|
>
|
|
{useUsernameLogin
|
|
? localize('com_auth_username').replace(/ \(.*$/, '')
|
|
: localize('com_auth_email_address')}
|
|
</label>
|
|
</div>
|
|
{renderError('email')}
|
|
</div>
|
|
<div className="mb-2">
|
|
<div className="relative">
|
|
<input
|
|
type="password"
|
|
id="password"
|
|
autoComplete="current-password"
|
|
aria-label={localize('com_auth_password')}
|
|
{...register('password', {
|
|
required: localize('com_auth_password_required'),
|
|
minLength: { value: 8, message: localize('com_auth_password_min_length') },
|
|
maxLength: { value: 128, message: localize('com_auth_password_max_length') },
|
|
})}
|
|
aria-invalid={!!errors.password}
|
|
className="webkit-dark-styles peer block w-full appearance-none rounded-md border border-gray-300 bg-transparent px-3.5 pb-3.5 pt-4 text-sm text-gray-900 focus:border-green-500 focus:outline-none focus:ring-0 dark:border-gray-600 dark:text-white dark:focus:border-green-500"
|
|
placeholder=" "
|
|
/>
|
|
<label
|
|
htmlFor="password"
|
|
className="absolute start-1 top-2 z-10 origin-[0] -translate-y-4 scale-75 transform bg-white px-3 text-sm text-gray-500 duration-100 peer-placeholder-shown:top-1/2 peer-placeholder-shown:-translate-y-1/2 peer-placeholder-shown:scale-100 peer-focus:top-2 peer-focus:-translate-y-4 peer-focus:scale-75 peer-focus:px-3 peer-focus:text-green-600 dark:bg-gray-900 dark:text-gray-400 dark:peer-focus:text-green-500 rtl:peer-focus:left-auto rtl:peer-focus:translate-x-1/4"
|
|
>
|
|
{localize('com_auth_password')}
|
|
</label>
|
|
</div>
|
|
{renderError('password')}
|
|
</div>
|
|
{startupConfig.passwordResetEnabled && (
|
|
<a href="/forgot-password" className="text-sm text-green-500">
|
|
{localize('com_auth_password_forgot')}
|
|
</a>
|
|
)}
|
|
<div className="mt-6">
|
|
<button
|
|
aria-label="Sign in"
|
|
data-testid="login-button"
|
|
type="submit"
|
|
className="w-full transform rounded-md bg-green-500 px-4 py-3 tracking-wide text-white transition-colors duration-200 hover:bg-green-550 focus:bg-green-550 focus:outline-none disabled:cursor-not-allowed disabled:hover:bg-green-500"
|
|
>
|
|
{localize('com_auth_continue')}
|
|
</button>
|
|
</div>
|
|
</form>
|
|
</>
|
|
);
|
|
};
|
|
|
|
export default LoginForm;
|