-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
plugin.ts
482 lines (424 loc) · 16.7 KB
/
plugin.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import type { Subscription } from 'rxjs';
import { map } from 'rxjs';
import type { CloudSetup, CloudStart } from '@kbn/cloud-plugin/server';
import type { TypeOf } from '@kbn/config-schema';
import type {
CoreSetup,
CoreStart,
KibanaRequest,
Logger,
Plugin,
PluginInitializerContext,
} from '@kbn/core/server';
import type { FeaturesPluginSetup, FeaturesPluginStart } from '@kbn/features-plugin/server';
import type { LicensingPluginSetup, LicensingPluginStart } from '@kbn/licensing-plugin/server';
import type {
AuditServiceSetup,
AuthorizationServiceSetup,
SecurityPluginSetup as SecurityPluginSetupWithoutDeprecatedMembers,
SecurityPluginStart,
} from '@kbn/security-plugin-types-server';
import type { SpacesPluginSetup, SpacesPluginStart } from '@kbn/spaces-plugin/server';
import type {
TaskManagerSetupContract,
TaskManagerStartContract,
} from '@kbn/task-manager-plugin/server';
import type { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server';
import { AnalyticsService } from './analytics';
import type { AnonymousAccessServiceStart } from './anonymous_access';
import { AnonymousAccessService } from './anonymous_access';
import { AuditService } from './audit';
import type { InternalAuthenticationServiceStart } from './authentication';
import { AuthenticationService } from './authentication';
import type { AuthorizationServiceSetupInternal } from './authorization';
import { AuthorizationService } from './authorization';
import { buildSecurityApi, buildUserProfileApi } from './build_delegate_apis';
import type { ConfigSchema, ConfigType } from './config';
import { createConfig } from './config';
import { getPrivilegeDeprecationsService, registerKibanaUserRoleDeprecation } from './deprecations';
import { ElasticsearchService } from './elasticsearch';
import type { SecurityFeatureUsageServiceStart } from './feature_usage';
import { SecurityFeatureUsageService } from './feature_usage';
import { securityFeatures } from './features';
import type { FipsServiceSetupInternal } from './fips';
import { FipsService } from './fips';
import { defineRoutes } from './routes';
import { setupSavedObjects } from './saved_objects';
import type { Session } from './session_management';
import { SessionManagementService } from './session_management';
import { setupSpacesClient } from './spaces';
import { registerSecurityUsageCollector } from './usage_collector';
import { UserProfileService } from './user_profile';
import type { UserProfileServiceStartInternal } from './user_profile';
import type { AuthenticatedUser, SecurityLicense } from '../common';
import { SecurityLicenseService } from '../common/licensing';
export type SpacesService = Pick<
SpacesPluginSetup['spacesService'],
'getSpaceId' | 'namespaceToSpaceId'
>;
/**
* Describes public Security plugin contract returned at the `setup` stage.
*/
export interface SecurityPluginSetup extends SecurityPluginSetupWithoutDeprecatedMembers {
/**
* @deprecated Use `authc` methods from the `SecurityServiceStart` contract instead.
*/
authc: {
getCurrentUser: (request: KibanaRequest) => AuthenticatedUser | null;
};
/**
* @deprecated Use `authz` methods from the `SecurityServiceStart` contract instead.
*/
authz: AuthorizationServiceSetup;
}
export interface PluginSetupDependencies {
features: FeaturesPluginSetup;
licensing: LicensingPluginSetup;
taskManager: TaskManagerSetupContract;
usageCollection?: UsageCollectionSetup;
spaces?: SpacesPluginSetup;
cloud?: CloudSetup;
}
export interface PluginStartDependencies {
cloud?: CloudStart;
features: FeaturesPluginStart;
licensing: LicensingPluginStart;
taskManager: TaskManagerStartContract;
spaces?: SpacesPluginStart;
}
/**
* Represents Security Plugin instance that will be managed by the Kibana plugin system.
*/
export class SecurityPlugin
implements Plugin<SecurityPluginSetup, SecurityPluginStart, PluginSetupDependencies>
{
private readonly logger: Logger;
private authorizationSetup?: AuthorizationServiceSetupInternal;
private auditSetup?: AuditServiceSetup;
private configSubscription?: Subscription;
private config?: ConfigType;
private readonly getConfig = () => {
if (!this.config) {
throw new Error('Config is not available.');
}
return this.config;
};
private session?: Session;
private readonly getSession = () => {
if (!this.session) {
throw new Error('Session is not available.');
}
return this.session;
};
private kibanaIndexName?: string;
private readonly getKibanaIndexName = () => {
if (!this.kibanaIndexName) {
throw new Error('Kibana index name is not available.');
}
return this.kibanaIndexName;
};
private readonly authenticationService: AuthenticationService;
private authenticationStart?: InternalAuthenticationServiceStart;
private readonly getAuthentication = () => {
if (!this.authenticationStart) {
throw new Error(`authenticationStart is not registered!`);
}
return this.authenticationStart;
};
private readonly featureUsageService = new SecurityFeatureUsageService();
private featureUsageServiceStart?: SecurityFeatureUsageServiceStart;
private readonly getFeatureUsageService = () => {
if (!this.featureUsageServiceStart) {
throw new Error(`featureUsageServiceStart is not registered!`);
}
return this.featureUsageServiceStart;
};
private readonly auditService: AuditService;
private readonly securityLicenseService = new SecurityLicenseService();
private readonly analyticsService: AnalyticsService;
private readonly authorizationService = new AuthorizationService();
private readonly elasticsearchService: ElasticsearchService;
private readonly sessionManagementService: SessionManagementService;
private readonly anonymousAccessService: AnonymousAccessService;
private anonymousAccessStart?: AnonymousAccessServiceStart;
private readonly getAnonymousAccess = () => {
if (!this.anonymousAccessStart) {
throw new Error(`anonymousAccessStart is not registered!`);
}
return this.anonymousAccessStart;
};
private readonly userProfileService: UserProfileService;
private userProfileStart?: UserProfileServiceStartInternal;
private readonly getUserProfileService = () => {
if (!this.userProfileStart) {
throw new Error(`userProfileStart is not registered!`);
}
return this.userProfileStart;
};
private readonly fipsService: FipsService;
private fipsServiceSetup?: FipsServiceSetupInternal;
constructor(private readonly initializerContext: PluginInitializerContext) {
this.logger = this.initializerContext.logger.get();
this.authenticationService = new AuthenticationService(
this.initializerContext.logger.get('authentication')
);
this.auditService = new AuditService(this.initializerContext.logger.get('audit'));
this.elasticsearchService = new ElasticsearchService(
this.initializerContext.logger.get('elasticsearch')
);
this.sessionManagementService = new SessionManagementService(
this.initializerContext.logger.get('session')
);
this.anonymousAccessService = new AnonymousAccessService(
this.initializerContext.logger.get('anonymous-access'),
this.getConfig
);
this.userProfileService = new UserProfileService(
this.initializerContext.logger.get('user-profile')
);
this.analyticsService = new AnalyticsService(this.initializerContext.logger.get('analytics'));
this.fipsService = new FipsService(this.initializerContext.logger.get('fips'));
}
public setup(
core: CoreSetup<PluginStartDependencies, SecurityPluginStart>,
{ features, licensing, taskManager, usageCollection, spaces }: PluginSetupDependencies
) {
this.kibanaIndexName = core.savedObjects.getDefaultIndex();
const config$ = this.initializerContext.config.create<TypeOf<typeof ConfigSchema>>().pipe(
map((rawConfig) =>
createConfig(rawConfig, this.initializerContext.logger.get('config'), {
isTLSEnabled: core.http.getServerInfo().protocol === 'https',
})
)
);
this.configSubscription = config$.subscribe((config) => {
this.config = config;
});
const config = this.getConfig();
const kibanaIndexName = this.getKibanaIndexName();
// A subset of `start` services we need during `setup`.
const startServicesPromise = core.getStartServices().then(([coreServices, depsServices]) => ({
elasticsearch: coreServices.elasticsearch,
features: depsServices.features,
}));
const { license } = this.securityLicenseService.setup({
license$: licensing.license$,
});
securityFeatures.forEach((securityFeature) =>
features.registerElasticsearchFeature(securityFeature)
);
this.elasticsearchService.setup({ license, status: core.status });
this.featureUsageService.setup({ featureUsage: licensing.featureUsage });
this.sessionManagementService.setup({ config, http: core.http, taskManager });
this.authenticationService.setup({
http: core.http,
elasticsearch: core.elasticsearch,
config,
license,
customBranding: core.customBranding,
});
registerSecurityUsageCollector({ usageCollection, config, license });
const getCurrentUser = (request: KibanaRequest) =>
this.getAuthentication().getCurrentUser(request);
this.auditSetup = this.auditService.setup({
license,
config: config.audit,
logging: core.logging,
http: core.http,
getSpaceId: (request) => spaces?.spacesService.getSpaceId(request),
getSID: (request) => this.getSession().getSID(request),
getCurrentUser,
recordAuditLoggingUsage: () => this.getFeatureUsageService().recordAuditLoggingUsage(),
});
this.anonymousAccessService.setup();
this.authorizationSetup = this.authorizationService.setup({
http: core.http,
capabilities: core.capabilities,
getClusterClient: () =>
startServicesPromise.then(({ elasticsearch }) => elasticsearch.client),
license,
loggers: this.initializerContext.logger,
kibanaIndexName,
packageVersion: this.initializerContext.env.packageInfo.version,
getSpacesService: () => spaces?.spacesService,
features,
getCurrentUser,
customBranding: core.customBranding,
});
this.userProfileService.setup({ authz: this.authorizationSetup, license });
this.fipsServiceSetup = this.fipsService.setup({ config, license });
this.fipsServiceSetup.validateLicenseForFips();
setupSpacesClient({
spaces,
audit: this.auditSetup,
authz: this.authorizationSetup,
getCurrentUser,
});
setupSavedObjects({
audit: this.auditSetup,
authz: this.authorizationSetup,
savedObjects: core.savedObjects,
getCurrentUser,
});
this.registerDeprecations(core, license);
core.security.registerSecurityDelegate(
buildSecurityApi({
getAuthc: this.getAuthentication.bind(this),
audit: this.auditSetup,
})
);
core.userProfile.registerUserProfileDelegate(
buildUserProfileApi({
getUserProfile: this.getUserProfileService.bind(this),
})
);
defineRoutes({
router: core.http.createRouter(),
basePath: core.http.basePath,
httpResources: core.http.resources,
logger: this.initializerContext.logger.get('routes'),
config,
config$,
authz: this.authorizationSetup,
license,
getSession: this.getSession,
getFeatures: () =>
startServicesPromise.then((services) => services.features.getKibanaFeatures()),
getFeatureUsageService: this.getFeatureUsageService,
getAuthenticationService: this.getAuthentication,
getAnonymousAccessService: this.getAnonymousAccess,
getUserProfileService: this.getUserProfileService,
analyticsService: this.analyticsService.setup({ analytics: core.analytics }),
buildFlavor: this.initializerContext.env.packageInfo.buildFlavor,
});
return Object.freeze<SecurityPluginSetup>({
audit: this.auditSetup,
authc: {
getCurrentUser: (request) => this.getAuthentication().getCurrentUser(request),
},
authz: {
actions: this.authorizationSetup.actions,
checkPrivilegesWithRequest: this.authorizationSetup.checkPrivilegesWithRequest,
checkPrivilegesDynamicallyWithRequest:
this.authorizationSetup.checkPrivilegesDynamicallyWithRequest,
checkSavedObjectsPrivilegesWithRequest:
this.authorizationSetup.checkSavedObjectsPrivilegesWithRequest,
mode: this.authorizationSetup.mode,
},
license,
privilegeDeprecationsService: getPrivilegeDeprecationsService({
authz: this.authorizationSetup,
getFeatures: () =>
startServicesPromise.then((services) => services.features.getKibanaFeatures()),
license,
logger: this.logger.get('deprecations'),
}),
});
}
public start(
core: CoreStart,
{ cloud, features, licensing, taskManager, spaces }: PluginStartDependencies
) {
this.logger.debug('Starting plugin');
this.featureUsageServiceStart = this.featureUsageService.start({
featureUsage: licensing.featureUsage,
});
const clusterClient = core.elasticsearch.client;
const { watchOnlineStatus$ } = this.elasticsearchService.start();
const { session } = this.sessionManagementService.start({
audit: this.auditSetup!,
elasticsearchClient: clusterClient.asInternalUser,
kibanaIndexName: this.getKibanaIndexName(),
online$: watchOnlineStatus$(),
taskManager,
});
this.session = session;
this.userProfileStart = this.userProfileService.start({ clusterClient, session });
// In serverless, we want to redirect users to the list of projects instead of standard "Logged Out" page.
const customLogoutURL =
this.initializerContext.env.packageInfo.buildFlavor === 'serverless'
? cloud?.projectsUrl
: undefined;
const config = this.getConfig();
this.authenticationStart = this.authenticationService.start({
audit: this.auditSetup!,
clusterClient,
config,
featureUsageService: this.featureUsageServiceStart,
userProfileService: this.userProfileStart,
http: core.http,
loggers: this.initializerContext.logger,
session,
applicationName: this.authorizationSetup!.applicationName,
kibanaFeatures: features.getKibanaFeatures(),
isElasticCloudDeployment: () => cloud?.isCloudEnabled === true,
customLogoutURL,
});
this.authorizationService.start({
features,
clusterClient,
online$: watchOnlineStatus$(),
});
this.anonymousAccessStart = this.anonymousAccessService.start({
capabilities: core.capabilities,
clusterClient,
basePath: core.http.basePath,
spaces: spaces?.spacesService,
});
return Object.freeze<SecurityPluginStart>({
authc: {
getCurrentUser: this.authenticationStart.getCurrentUser,
apiKeys: this.authenticationStart.apiKeys,
},
authz: {
actions: this.authorizationSetup!.actions,
checkPrivilegesWithRequest: this.authorizationSetup!.checkPrivilegesWithRequest,
checkPrivilegesDynamicallyWithRequest:
this.authorizationSetup!.checkPrivilegesDynamicallyWithRequest,
checkSavedObjectsPrivilegesWithRequest:
this.authorizationSetup!.checkSavedObjectsPrivilegesWithRequest,
mode: this.authorizationSetup!.mode,
},
userProfiles: {
getCurrent: this.userProfileStart.getCurrent,
bulkGet: this.userProfileStart.bulkGet,
suggest: this.userProfileStart.suggest,
},
});
}
public stop() {
this.logger.debug('Stopping plugin');
if (this.configSubscription) {
this.configSubscription.unsubscribe();
this.configSubscription = undefined;
}
if (this.featureUsageServiceStart) {
this.featureUsageServiceStart = undefined;
}
if (this.authenticationStart) {
this.authenticationStart = undefined;
}
if (this.anonymousAccessStart) {
this.anonymousAccessStart = undefined;
}
this.securityLicenseService.stop();
this.auditService.stop();
this.authorizationService.stop();
this.sessionManagementService.stop();
}
private registerDeprecations(core: CoreSetup, license: SecurityLicense) {
const logger = this.logger.get('deprecations');
registerKibanaUserRoleDeprecation({
deprecationsService: core.deprecations,
license,
logger,
packageInfo: this.initializerContext.env.packageInfo,
});
}
}