feat(web,server): disable password login (#1223)

* feat(web,server): disable password login

* chore: unit tests

* chore: fix import

* chore: linting

* feat(cli): server command for enable/disable password login

* chore: update docs

* feat(web): confirm dialogue

* chore: linting

* chore: linting

* chore: linting

* chore: linting

* chore: linting

* chore: fix web test

* chore: server unit tests
This commit is contained in:
Jason Rasmussen 2023-01-09 16:32:58 -05:00 committed by GitHub
parent 5999af6c78
commit bd838a71d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
66 changed files with 861 additions and 167 deletions

View file

@ -1377,6 +1377,12 @@ export interface OAuthConfigResponseDto {
* @memberof OAuthConfigResponseDto
*/
'enabled': boolean;
/**
*
* @type {boolean}
* @memberof OAuthConfigResponseDto
*/
'passwordLoginEnabled': boolean;
/**
*
* @type {string}
@ -1389,6 +1395,12 @@ export interface OAuthConfigResponseDto {
* @memberof OAuthConfigResponseDto
*/
'buttonText'?: string;
/**
*
* @type {boolean}
* @memberof OAuthConfigResponseDto
*/
'autoLaunch'?: boolean;
}
/**
*
@ -1602,10 +1614,10 @@ export interface SharedLinkResponseDto {
'expiresAt': string | null;
/**
*
* @type {Array<string>}
* @type {Array<AssetResponseDto>}
* @memberof SharedLinkResponseDto
*/
'assets': Array<string>;
'assets': Array<AssetResponseDto>;
/**
*
* @type {AlbumResponseDto}
@ -1707,6 +1719,12 @@ export interface SystemConfigDto {
* @memberof SystemConfigDto
*/
'oauth': SystemConfigOAuthDto;
/**
*
* @type {SystemConfigPasswordLoginDto}
* @memberof SystemConfigDto
*/
'passwordLogin': SystemConfigPasswordLoginDto;
/**
*
* @type {SystemConfigStorageTemplateDto}
@ -1799,6 +1817,12 @@ export interface SystemConfigOAuthDto {
* @memberof SystemConfigOAuthDto
*/
'autoRegister': boolean;
/**
*
* @type {boolean}
* @memberof SystemConfigOAuthDto
*/
'autoLaunch': boolean;
/**
*
* @type {boolean}
@ -1812,6 +1836,19 @@ export interface SystemConfigOAuthDto {
*/
'mobileRedirectUri': string;
}
/**
*
* @export
* @interface SystemConfigPasswordLoginDto
*/
export interface SystemConfigPasswordLoginDto {
/**
*
* @type {boolean}
* @memberof SystemConfigPasswordLoginDto
*/
'enabled': boolean;
}
/**
*
* @export

View file

@ -22,6 +22,15 @@ export const oauth = {
const search = location.search;
return search.includes('code=') || search.includes('error=');
},
isAutoLaunchDisabled: (location: Location) => {
const values = ['autoLaunch=0', 'password=1', 'password=true'];
for (const value of values) {
if (location.search.includes(value)) {
return true;
}
}
return false;
},
getConfig: (location: Location) => {
const redirectUri = location.href.split('?')[0];
console.log(`OAuth Redirect URI: ${redirectUri}`);

View file

@ -0,0 +1,25 @@
<script lang="ts">
import ConfirmDialogue from '$lib/components/shared-components/confirm-dialogue.svelte';
</script>
<ConfirmDialogue title="Disable Login" on:cancel on:confirm>
<svelte:fragment slot="prompt">
<div class="flex flex-col gap-4 p-3">
<p class="text-md text-center">
Are you sure you want to disable all login methods? Login will be completely disabled.
</p>
<p class="text-md text-center">
To re-enable, use a
<a
href="https://immich.app/docs/features/server-commands"
rel="noreferrer"
target="_blank"
class="underline"
>
Server Command</a
>.
</p>
</div>
</svelte:fragment>
</ConfirmDialogue>

View file

@ -7,6 +7,7 @@
import { api, SystemConfigOAuthDto } from '@api';
import _ from 'lodash';
import { fade } from 'svelte/transition';
import ConfirmDisableLogin from '../confirm-disable-login.svelte';
import SettingButtonsRow from '../setting-buttons-row.svelte';
import SettingInputField, { SettingInputFieldType } from '../setting-input-field.svelte';
import SettingSwitch from '../setting-switch.svelte';
@ -43,26 +44,43 @@
});
}
let isConfirmOpen = false;
let handleConfirm: (value: boolean) => void;
const openConfirmModal = () => {
return new Promise((resolve) => {
handleConfirm = (value: boolean) => {
isConfirmOpen = false;
resolve(value);
};
isConfirmOpen = true;
});
};
async function saveSetting() {
try {
const { data: currentConfig } = await api.systemConfigApi.getConfig();
const { data: current } = await api.systemConfigApi.getConfig();
if (!current.passwordLogin.enabled && current.oauth.enabled && !oauthConfig.enabled) {
const confirmed = await openConfirmModal();
if (!confirmed) {
return;
}
}
if (!oauthConfig.mobileOverrideEnabled) {
oauthConfig.mobileRedirectUri = '';
}
const result = await api.systemConfigApi.updateConfig({
...currentConfig,
const { data: updated } = await api.systemConfigApi.updateConfig({
...current,
oauth: oauthConfig
});
oauthConfig = { ...result.data.oauth };
savedConfig = { ...result.data.oauth };
oauthConfig = { ...updated.oauth };
savedConfig = { ...updated.oauth };
notificationController.show({
message: 'OAuth settings saved',
type: NotificationType.Info
});
notificationController.show({ message: 'OAuth settings saved', type: NotificationType.Info });
} catch (error) {
handleError(error, 'Unable to save OAuth settings');
}
@ -80,6 +98,13 @@
}
</script>
{#if isConfirmOpen}
<ConfirmDisableLogin
on:cancel={() => handleConfirm(false)}
on:confirm={() => handleConfirm(true)}
/>
{/if}
<div class="mt-2">
{#await getConfigs() then}
<div in:fade={{ duration: 500 }}>
@ -147,6 +172,13 @@
disabled={!oauthConfig.enabled}
/>
<SettingSwitch
title="AUTO LAUNCH"
subtitle="Start the OAuth login flow automatically upon navigating to the login page"
disabled={!oauthConfig.enabled}
bind:checked={oauthConfig.autoLaunch}
/>
<SettingSwitch
title="MOBILE REDIRECT URI OVERRIDE"
subtitle="Enable when `app.immich:/` is an invalid redirect URI."

View file

@ -0,0 +1,119 @@
<script lang="ts">
import {
notificationController,
NotificationType
} from '$lib/components/shared-components/notification/notification';
import { handleError } from '$lib/utils/handle-error';
import { api, SystemConfigPasswordLoginDto } from '@api';
import _ from 'lodash';
import { fade } from 'svelte/transition';
import ConfirmDisableLogin from '../confirm-disable-login.svelte';
import SettingButtonsRow from '../setting-buttons-row.svelte';
import SettingSwitch from '../setting-switch.svelte';
export let passwordLoginConfig: SystemConfigPasswordLoginDto; // this is the config that is being edited
let savedConfig: SystemConfigPasswordLoginDto;
let defaultConfig: SystemConfigPasswordLoginDto;
async function getConfigs() {
[savedConfig, defaultConfig] = await Promise.all([
api.systemConfigApi.getConfig().then((res) => res.data.passwordLogin),
api.systemConfigApi.getDefaults().then((res) => res.data.passwordLogin)
]);
}
let isConfirmOpen = false;
let handleConfirm: (value: boolean) => void;
const openConfirmModal = () => {
return new Promise((resolve) => {
handleConfirm = (value: boolean) => {
isConfirmOpen = false;
resolve(value);
};
isConfirmOpen = true;
});
};
async function saveSetting() {
try {
const { data: current } = await api.systemConfigApi.getConfig();
if (!current.oauth.enabled && current.passwordLogin.enabled && !passwordLoginConfig.enabled) {
const confirmed = await openConfirmModal();
if (!confirmed) {
return;
}
}
const { data: updated } = await api.systemConfigApi.updateConfig({
...current,
passwordLogin: passwordLoginConfig
});
passwordLoginConfig = { ...updated.passwordLogin };
savedConfig = { ...updated.passwordLogin };
notificationController.show({ message: 'Settings saved', type: NotificationType.Info });
} catch (error) {
handleError(error, 'Unable to save settings');
}
}
async function reset() {
const { data: resetConfig } = await api.systemConfigApi.getConfig();
passwordLoginConfig = { ...resetConfig.passwordLogin };
savedConfig = { ...resetConfig.passwordLogin };
notificationController.show({
message: 'Reset settings to the recent saved settings',
type: NotificationType.Info
});
}
async function resetToDefault() {
const { data: configs } = await api.systemConfigApi.getDefaults();
passwordLoginConfig = { ...configs.passwordLogin };
defaultConfig = { ...configs.passwordLogin };
notificationController.show({
message: 'Reset password settings to default',
type: NotificationType.Info
});
}
</script>
{#if isConfirmOpen}
<ConfirmDisableLogin
on:cancel={() => handleConfirm(false)}
on:confirm={() => handleConfirm(true)}
/>
{/if}
<div>
{#await getConfigs() then}
<div in:fade={{ duration: 500 }}>
<form autocomplete="off" on:submit|preventDefault>
<div class="flex flex-col gap-4 ml-4 mt-4">
<div class="ml-4">
<SettingSwitch
title="ENABLED"
subtitle="Login with email and password"
bind:checked={passwordLoginConfig.enabled}
/>
<SettingButtonsRow
on:reset={reset}
on:save={saveSetting}
on:reset-to-default={resetToDefault}
showResetToDefault={!_.isEqual(savedConfig, defaultConfig)}
/>
</div>
</div>
</form>
</div>
{/await}
</div>

View file

@ -93,7 +93,6 @@ describe('AlbumCard component', () => {
expect(apiMock.assetApi.getAssetThumbnail).toHaveBeenCalledWith(
'thumbnailIdOne',
ThumbnailFormat.Jpeg,
'',
{ responseType: 'blob' }
);
expect(createObjectURLMock).toHaveBeenCalledWith(thumbnailBlob);

View file

@ -439,7 +439,7 @@
const handleDownloadSelectedAssets = async () => {
await bulkDownload(
album.albumName,
album.albumName,
Array.from(multiSelectAsset),
() => {
isMultiSelectionMode = false;

View file

@ -6,7 +6,7 @@
export let album: AlbumResponseDto;
export let variant: 'simple' | 'full' = 'full';
export let searchQuery: string = '';
export let searchQuery = '';
let albumNameArray: string[] = ['', '', ''];
// This part of the code is responsible for splitting album name into 3 parts where part 2 is the search query

View file

@ -9,7 +9,6 @@
export let publicSharedKey = '';
let asset: AssetResponseDto;
let videoPlayerNode: HTMLVideoElement;
let isVideoLoading = true;
let videoUrl: string;
const dispatch = createEventDispatcher();
@ -55,7 +54,6 @@
class="h-full object-contain"
on:canplay={handleCanPlay}
on:ended={() => dispatch('onVideoEnded')}
bind:this={videoPlayerNode}
>
<source src={videoUrl} type="video/mp4" />
<track kind="captions" />

View file

@ -1,4 +1,5 @@
<script lang="ts">
import { goto } from '$app/navigation';
import LoadingSpinner from '$lib/components/shared-components/loading-spinner.svelte';
import { loginPageMessage } from '$lib/constants';
import { api, oauth, OAuthConfigResponseDto } from '@api';
@ -8,7 +9,7 @@
let email = '';
let password = '';
let oauthError: string;
let oauthConfig: OAuthConfigResponseDto = { enabled: false };
let oauthConfig: OAuthConfigResponseDto = { enabled: false, passwordLoginEnabled: false };
let loading = true;
const dispatch = createEventDispatcher();
@ -30,6 +31,14 @@
try {
const { data } = await oauth.getConfig(window.location);
oauthConfig = data;
const { enabled, url, autoLaunch } = oauthConfig;
if (enabled && url && autoLaunch && !oauth.isAutoLaunchDisabled(window.location)) {
await goto('/auth/login?autoLaunch=0', { replaceState: true });
await goto(url);
return;
}
} catch (e) {
console.error('Error [login-form] [oauth.generateConfig]', e);
}
@ -83,60 +92,68 @@
<LoadingSpinner />
</div>
{:else}
<form on:submit|preventDefault={login} autocomplete="off">
<div class="m-4 flex flex-col gap-2">
<label class="immich-form-label" for="email">Email</label>
<input
class="immich-form-input"
id="email"
name="email"
type="email"
bind:value={email}
required
/>
</div>
<div class="m-4 flex flex-col gap-2">
<label class="immich-form-label" for="password">Password</label>
<input
class="immich-form-input"
id="password"
name="password"
type="password"
bind:value={password}
required
/>
</div>
{#if error}
<p class="text-red-400 pl-4">{error}</p>
{/if}
<div class="flex w-full">
<button
type="submit"
disabled={loading}
class="m-4 p-2 bg-immich-primary dark:bg-immich-dark-primary dark:text-immich-dark-gray dark:hover:bg-immich-dark-primary/80 hover:bg-immich-primary/75 px-6 py-4 text-white rounded-md shadow-md w-full font-semibold"
>Login</button
>
</div>
{#if oauthConfig.enabled}
<div class="flex flex-col gap-4 px-4">
<hr />
{#if oauthError}
<p class="text-red-400">{oauthError}</p>
{/if}
<a href={oauthConfig.url} class="flex w-full">
<button
type="button"
disabled={loading}
class="bg-immich-primary dark:bg-immich-dark-primary dark:text-immich-dark-gray dark:hover:bg-immich-dark-primary/80 hover:bg-immich-primary/75 px-6 py-4 text-white rounded-md shadow-md w-full font-semibold"
>{oauthConfig.buttonText || 'Login with OAuth'}</button
>
</a>
{#if oauthConfig.passwordLoginEnabled}
<form on:submit|preventDefault={login} autocomplete="off">
<div class="m-4 flex flex-col gap-2">
<label class="immich-form-label" for="email">Email</label>
<input
class="immich-form-input"
id="email"
name="email"
type="email"
bind:value={email}
required
/>
</div>
{/if}
</form>
<div class="m-4 flex flex-col gap-2">
<label class="immich-form-label" for="password">Password</label>
<input
class="immich-form-input"
id="password"
name="password"
type="password"
bind:value={password}
required
/>
</div>
{#if error}
<p class="text-red-400 pl-4">{error}</p>
{/if}
<div class="flex w-full">
<button
type="submit"
disabled={loading}
class="m-4 p-2 bg-immich-primary dark:bg-immich-dark-primary dark:text-immich-dark-gray dark:hover:bg-immich-dark-primary/80 hover:bg-immich-primary/75 px-6 py-4 text-white rounded-md shadow-md w-full font-semibold"
>Login</button
>
</div>
</form>
{/if}
{#if oauthConfig.enabled}
<div class="flex flex-col gap-4 px-4">
{#if oauthConfig.passwordLoginEnabled}
<hr />
{/if}
{#if oauthError}
<p class="text-red-400">{oauthError}</p>
{/if}
<a href={oauthConfig.url} class="flex w-full">
<button
type="button"
disabled={loading}
class="bg-immich-primary dark:bg-immich-dark-primary dark:text-immich-dark-gray dark:hover:bg-immich-dark-primary/80 hover:bg-immich-primary/75 px-6 py-4 text-white rounded-md shadow-md w-full font-semibold"
>{oauthConfig.buttonText || 'Login with OAuth'}</button
>
</a>
</div>
{/if}
{#if !oauthConfig.enabled && !oauthConfig.passwordLoginEnabled}
<p class="text-center dark:text-immich-dark-fg p-4">Login has been disabled.</p>
{/if}
{/if}
</div>

View file

@ -2,8 +2,8 @@
import { createEventDispatcher } from 'svelte';
import FullScreenModal from './full-screen-modal.svelte';
export let title = 'Confirm Delete';
export let prompt = 'Are you sure you want to delete this item?';
export let title = 'Confirm';
export let prompt = 'Are you sure you want to do this?';
export let confirmText = 'Confirm';
export let cancelText = 'Cancel';
@ -19,12 +19,14 @@
<div
class="flex flex-col place-items-center place-content-center gap-4 px-4 text-immich-primary dark:text-immich-dark-primary"
>
<h1 class="text-2xl text-immich-primary dark:text-immich-dark-primary font-medium">
<h1 class="text-2xl text-immich-primary dark:text-immich-dark-primary font-medium pb-2">
{title}
</h1>
</div>
<div>
<p class="ml-4 text-md py-5 text-center">{prompt}</p>
<slot name="prompt">
<p class="ml-4 text-md py-5 text-center">{prompt}</p>
</slot>
<div class="flex w-full px-4 gap-4 mt-4">
<button

View file

@ -15,7 +15,6 @@
export let album: AlbumResponseDto | undefined;
export let editingLink: SharedLinkResponseDto | undefined = undefined;
let isLoading = false;
let isShowSharedLink = false;
let expirationTime = '';
let isAllowUpload = false;
@ -40,7 +39,6 @@
const createAlbumSharedLink = async () => {
if (album) {
isLoading = true;
try {
const expirationTime = getExpirationTimeInMillisecond();
const currentTime = new Date().getTime();
@ -56,7 +54,6 @@
});
buildSharedLink(data);
isLoading = false;
isShowSharedLink = true;
} catch (e) {
console.error('[createAlbumSharedLink] Error: ', e);
@ -64,7 +61,6 @@
type: NotificationType.Error,
message: 'Failed to create shared link'
});
isLoading = false;
}
}
};

View file

@ -34,9 +34,9 @@
const logOut = async () => {
const { data } = await api.authenticationApi.logout();
await fetch('auth/logout', { method: 'POST' });
await fetch('/auth/logout', { method: 'POST' });
goto(data.redirectUri || '/auth/login');
goto(data.redirectUri || '/auth/login?autoLaunch=0');
};
</script>

View file

@ -47,9 +47,8 @@
<script lang="ts">
/**
* DOM Element or CSS Selector
* @type { HTMLElement|string}
*/
export let target = 'body';
export let target: HTMLElement | string = 'body';
</script>
<div use:portal={target} hidden>

View file

@ -21,7 +21,7 @@
if (link.album?.albumThumbnailAssetId) {
assetId = link.album.albumThumbnailAssetId;
} else if (link.assets.length > 0) {
assetId = link.assets[0];
assetId = link.assets[0].id;
}
const { data } = await api.assetApi.getAssetById(assetId);

View file

@ -12,7 +12,7 @@
export let user: UserResponseDto;
let config: OAuthConfigResponseDto = { enabled: false };
let config: OAuthConfigResponseDto = { enabled: false, passwordLoginEnabled: true };
let loading = true;
onMount(async () => {

View file

@ -7,7 +7,7 @@
import { handleError } from '../../utils/handle-error';
import APIKeyForm from '../forms/api-key-form.svelte';
import APIKeySecret from '../forms/api-key-secret.svelte';
import DeleteConfirmDialogue from '../shared-components/delete-confirm-dialogue.svelte';
import ConfirmDialogue from '../shared-components/confirm-dialogue.svelte';
import {
notificationController,
NotificationType
@ -114,7 +114,7 @@
{/if}
{#if deleteKey}
<DeleteConfirmDialogue
<ConfirmDialogue
prompt="Are you sure you want to delete this API Key?"
on:confirm={() => handleDelete()}
on:cancel={() => (deleteKey = null)}

View file

@ -4,7 +4,6 @@ import {
NotificationType
} from '$lib/components/shared-components/notification/notification';
import { downloadAssets } from '$lib/stores/download';
import { get } from 'svelte/store';
export const addAssetsToAlbum = async (
albumId: string,
@ -34,7 +33,7 @@ export async function bulkDownload(
const assetIds = assets.map((asset) => asset.id);
try {
let skip = 0;
// let skip = 0;
let count = 0;
let done = false;
@ -68,7 +67,7 @@ export async function bulkDownload(
const isNotComplete = headers['x-immich-archive-complete'] === 'false';
const fileCount = Number(headers['x-immich-archive-file-count']) || 0;
if (isNotComplete && fileCount > 0) {
skip += fileCount;
// skip += fileCount;
} else {
onDone();
done = true;

View file

@ -1,19 +1,18 @@
<script lang="ts">
import { page } from '$app/stores';
import FFmpegSettings from '$lib/components/admin-page/settings/ffmpeg/ffmpeg-settings.svelte';
import OAuthSettings from '$lib/components/admin-page/settings/oauth/oauth-settings.svelte';
import PasswordLoginSettings from '$lib/components/admin-page/settings/password-login/password-login-settings.svelte';
import SettingAccordion from '$lib/components/admin-page/settings/setting-accordion.svelte';
import StorageTemplateSettings from '$lib/components/admin-page/settings/storate-template/storage-template-settings.svelte';
import LoadingSpinner from '$lib/components/shared-components/loading-spinner.svelte';
import { api, SystemConfigDto } from '@api';
import { api } from '@api';
import type { PageData } from './$types';
import { page } from '$app/stores';
let systemConfig: SystemConfigDto;
export let data: PageData;
const getConfig = async () => {
const { data } = await api.systemConfigApi.getConfig();
systemConfig = data;
return data;
};
</script>
@ -33,7 +32,14 @@
<FFmpegSettings ffmpegConfig={configs.ffmpeg} />
</SettingAccordion>
<SettingAccordion title="OAuth Settings" subtitle="Manage the OAuth integration to Immich app">
<SettingAccordion
title="Password Authentication"
subtitle="Manage login with password settings"
>
<PasswordLoginSettings passwordLoginConfig={configs.passwordLogin} />
</SettingAccordion>
<SettingAccordion title="OAuth Authentication" subtitle="Manage the login with OAuth settings">
<OAuthSettings oauthConfig={configs.oauth} />
</SettingAccordion>