helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-11-07 17:27:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(server): add api key to openapi spec (#2362)

Browse source 
* feat(server): add api key to openapi spec

* regenerate api
This commit is contained in:
Michel Heusschen 2023-05-04 18:41:29 +02:00 • committed by GitHub
parent af7da9d2c9
commit 15a498fd60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 903 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

14
server/apps/immich/src/decorators/authenticated.decorator.ts
View file

@ -1,5 +1,6 @@
import { IMMICH_API_KEY_NAME } from '@app/domain';
import { applyDecorators, SetMetadata } from '@nestjs/common';
import { ApiBearerAuth, ApiCookieAuth, ApiQuery } from '@nestjs/swagger';
import { ApiBearerAuth, ApiCookieAuth, ApiQuery, ApiSecurity } from '@nestjs/swagger';
interface AuthenticatedOptions {
admin?: boolean;
@ -12,10 +13,13 @@ export enum Metadata {
SHARED_ROUTE = 'shared_route',
}
export const Authenticated = (options?: AuthenticatedOptions) => {
const decorators: MethodDecorator[] = [ApiBearerAuth(), ApiCookieAuth(), SetMetadata(Metadata.AUTH_ROUTE, true)];
options = options || {};
export const Authenticated = (options: AuthenticatedOptions = {}) => {
const decorators: MethodDecorator[] = [
ApiBearerAuth(),
ApiCookieAuth(),
ApiSecurity(IMMICH_API_KEY_NAME),
SetMetadata(Metadata.AUTH_ROUTE, true),
];
if (options.admin) {
decorators.push(SetMetadata(Metadata.ADMIN_ROUTE, true));

19
server/apps/immich/src/main.ts
View file

@ -9,8 +9,15 @@ import { AppModule } from './app.module';
import { RedisIoAdapter } from '@app/infra';
import { json } from 'body-parser';
import { patchOpenAPI } from './utils/patch-open-api.util';
import { getLogLevels, MACHINE_LEARNING_ENABLED } from '@app/domain';
import { SERVER_VERSION, IMMICH_ACCESS_COOKIE, SearchService } from '@app/domain';
import {
getLogLevels,
MACHINE_LEARNING_ENABLED,
SERVER_VERSION,
IMMICH_ACCESS_COOKIE,
SearchService,
IMMICH_API_KEY_HEADER,
IMMICH_API_KEY_NAME,
} from '@app/domain';
const logger = new Logger('ImmichServer');
@ -41,6 +48,14 @@ async function bootstrap() {
in: 'header',
})
.addCookieAuth(IMMICH_ACCESS_COOKIE)
.addApiKey(
{
type: 'apiKey',
in: 'header',
name: IMMICH_API_KEY_HEADER,
},
IMMICH_API_KEY_NAME,
)
.addServer('/api')
.build();

239
server/immich-openapi-specs.json
View file

@ -48,6 +48,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -85,6 +88,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -124,6 +130,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -154,6 +163,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -193,6 +205,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -240,6 +255,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -270,6 +288,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -367,6 +388,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -399,6 +423,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -428,6 +455,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -467,6 +497,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -496,6 +529,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -525,6 +561,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -573,6 +612,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -688,6 +730,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -717,6 +762,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -879,6 +927,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -908,6 +959,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -940,6 +994,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -969,6 +1026,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1040,6 +1100,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1072,6 +1135,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1110,6 +1176,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1149,6 +1218,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -1179,6 +1251,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -1226,6 +1301,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1255,6 +1333,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -1292,6 +1373,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1321,6 +1405,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1350,6 +1437,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1391,6 +1481,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -1428,6 +1521,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -1465,6 +1561,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1504,6 +1603,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1533,6 +1635,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1603,6 +1708,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1642,6 +1750,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1682,6 +1793,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1721,6 +1835,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1770,6 +1887,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1818,6 +1938,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1870,6 +1993,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1926,6 +2052,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -1992,6 +2121,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2048,6 +2180,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2080,6 +2215,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2112,6 +2250,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2144,6 +2285,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2186,6 +2330,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2225,6 +2372,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2254,6 +2404,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2283,6 +2436,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2350,6 +2506,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -2390,6 +2549,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2432,6 +2594,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2475,6 +2640,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2523,6 +2691,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2573,6 +2744,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2622,6 +2796,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2662,6 +2839,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2701,6 +2881,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2749,6 +2932,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2797,6 +2983,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2836,6 +3025,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -2866,6 +3058,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -2905,6 +3100,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -2952,6 +3150,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -2982,6 +3183,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3011,6 +3215,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3060,6 +3267,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3117,6 +3327,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -3164,6 +3377,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3211,6 +3427,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -3241,6 +3460,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
},
@ -3288,6 +3510,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3328,6 +3553,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3392,6 +3620,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3431,6 +3662,9 @@
},
{
"cookie": []
},
{
"api_key": []
}
]
}
@ -3460,6 +3694,11 @@
"type": "apiKey",
"in": "cookie",
"name": "immich_access_token"
},
"api_key": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
},
"schemas": {

2
server/libs/domain/src/auth/auth.constant.ts
View file

@ -1,5 +1,7 @@
export const IMMICH_ACCESS_COOKIE = 'immich_access_token';
export const IMMICH_AUTH_TYPE_COOKIE = 'immich_auth_type';
export const IMMICH_API_KEY_NAME = 'api_key';
export const IMMICH_API_KEY_HEADER = 'x-api-key';
export enum AuthType {
PASSWORD = 'password',
OAUTH = 'oauth',

4
server/libs/domain/src/auth/auth.service.ts
View file

@ -11,7 +11,7 @@ import { IncomingHttpHeaders } from 'http';
import { OAuthCore } from '../oauth/oauth.core';
import { INITIAL_SYSTEM_CONFIG, ISystemConfigRepository } from '../system-config';
import { IUserRepository, UserCore } from '../user';
import { AuthType, IMMICH_ACCESS_COOKIE } from './auth.constant';
import { AuthType, IMMICH_ACCESS_COOKIE, IMMICH_API_KEY_HEADER } from './auth.constant';
import { AuthCore, LoginDetails } from './auth.core';
import { ICryptoRepository } from '../crypto/crypto.repository';
import { AuthUserDto, ChangePasswordDto, LoginCredentialDto, SignUpDto } from './dto';
@ -137,7 +137,7 @@ export class AuthService {
params.userToken ||
this.getBearerToken(headers) ||
this.getCookieToken(headers)) as string;
const apiKey = (headers['x-api-key'] || params.apiKey) as string;
const apiKey = (headers[IMMICH_API_KEY_HEADER] || params.apiKey) as string;
if (shareKey) {
return this.shareCore.validate(shareKey);