[7.x] introduce pre-/post-auth request hooks for HttpServer (#36690) (#…

…38265)

* introduce pre-/post-auth request hooks for HttpServer (#36690)

* introduce pre-,post-auth stages

* cleanup integration_tests. now contracts available in tests

* auth per route is configurable

* Unify lifecycle results structure

* expose api to store auth state and status via http service

* update tests

* update docs

* use full name, auth should not mutate request

* move basePath functionality under namespace

* regenerate docs

* Revert "move basePath functionality under namespace"

This reverts commit 9599d32.

* Revert "regenerate docs"

This reverts commit 1799d3b.

* regenerate docs

* updated yarn.lock no idea why

* extract AuthStateStorage to a separate entity

* get rid of nested ifs

* describe what is the difference between hooks

* re-wording

* fix typings

docs/development/core/server/kibana-plugin-server.authenticationhandler.md

@@ -8,5 +8,5 @@
 <b>Signature:</b>
 
 ```typescript
-export declare type AuthenticationHandler<T> = (request: Request, sessionStorage: SessionStorage<T>, t: AuthToolkit) => Promise<AuthResult>;
+export declare type AuthenticationHandler<T> = (request: Readonly<Request>, sessionStorage: SessionStorage<T>, t: AuthToolkit) => AuthResult | Promise<AuthResult>;
 ```

docs/development/core/server/kibana-plugin-server.authtoolkit.authenticated.md

@@ -9,5 +9,5 @@ Authentication is successful with given credentials, allow request to pass throu
 <b>Signature:</b>
 
 ```typescript
-authenticated: (credentials: any) => AuthResult;
+authenticated: (state: object) => AuthResult;
 ```

docs/development/core/server/kibana-plugin-server.authtoolkit.md

@@ -16,7 +16,7 @@ export interface AuthToolkit
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(credentials: any) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
+|  [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(state: object) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
 |  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(url: string) =&gt; AuthResult</code> | Authentication requires to interrupt request handling and redirect to a configured url |
 |  [rejected](./kibana-plugin-server.authtoolkit.rejected.md) | <code>(error: Error, options?: {`<p/>`        statusCode?: number;`<p/>`    }) =&gt; AuthResult</code> | Authentication is unsuccessful, fail the request with specified error. |
 

docs/development/core/server/kibana-plugin-server.coresetup.http.md

@@ -8,8 +8,9 @@
 
 ```typescript
 http: {
+        registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];
         registerAuth: HttpServiceSetup['registerAuth'];
-        registerOnRequest: HttpServiceSetup['registerOnRequest'];
+        registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];
         getBasePathFor: HttpServiceSetup['getBasePathFor'];
         setBasePathFor: HttpServiceSetup['setBasePathFor'];
         createNewServer: HttpServiceSetup['createNewServer'];

docs/development/core/server/kibana-plugin-server.coresetup.md

@@ -9,12 +9,13 @@ Context passed to the plugins `setup` method.
 <b>Signature:</b>
 
 ```typescript
-export interface CoreSetup
+export interface CoreSetup 
 ```
 
 ## Properties
 
-| Property                                                           | Type                                                                                                                                                                                                                                                                                                                                                                                           | Description |
-| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>{`<p/>` adminClient\$: Observable&lt;ClusterClient&gt;;`<p/>` dataClient\$: Observable&lt;ClusterClient&gt;;`<p/>` }</code>                                                                                                                                                                                                                                                              |             |
-| [http](./kibana-plugin-server.coresetup.http.md)                   | <code>{`<p/>` registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];`<p/>` registerAuth: HttpServiceSetup['registerAuth'];`<p/>` registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];`<p/>` getBasePathFor: HttpServiceSetup['getBasePathFor'];`<p/>` setBasePathFor: HttpServiceSetup['setBasePathFor'];`<p/>` createNewServer: HttpServiceSetup['createNewServer'];`<p/>` }</code> |             |
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>{`<p/>`        adminClient$: Observable&lt;ClusterClient&gt;;`<p/>`        dataClient$: Observable&lt;ClusterClient&gt;;`<p/>`    }</code> |  |
+|  [http](./kibana-plugin-server.coresetup.http.md) | <code>{`<p/>`        registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];`<p/>`        registerAuth: HttpServiceSetup['registerAuth'];`<p/>`        registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];`<p/>`        getBasePathFor: HttpServiceSetup['getBasePathFor'];`<p/>`        setBasePathFor: HttpServiceSetup['setBasePathFor'];`<p/>`    }</code> |  |
+

docs/development/core/server/kibana-plugin-server.kibanarequest.md

@@ -20,6 +20,7 @@ export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unk
 |  [params](./kibana-plugin-server.kibanarequest.params.md) |  | <code>Params</code> |  |
 |  [path](./kibana-plugin-server.kibanarequest.path.md) |  | <code>string</code> |  |
 |  [query](./kibana-plugin-server.kibanarequest.query.md) |  | <code>Query</code> |  |
+|  [url](./kibana-plugin-server.kibanarequest.url.md) |  | <code>Url</code> |  |
 
 ## Methods
 

docs/development/core/server/kibana-plugin-server.kibanarequest.url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [KibanaRequest](./kibana-plugin-server.kibanarequest.md) &gt; [url](./kibana-plugin-server.kibanarequest.url.md)
+
+## KibanaRequest.url property
+
+<b>Signature:</b>
+
+```typescript
+readonly url: Url;
+```

docs/development/core/server/kibana-plugin-server.md

@@ -12,44 +12,46 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 
 ## Classes
 
-| Class                                                                | Description                                                                                                                                                                                                                                                                                                                                    |
-| -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [ClusterClient](./kibana-plugin-server.clusterclient.md)             | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>).                                                                                                                                     |
-| [KibanaRequest](./kibana-plugin-server.kibanarequest.md)             |                                                                                                                                                                                                                                                                                                                                                |
-| [Router](./kibana-plugin-server.router.md)                           |                                                                                                                                                                                                                                                                                                                                                |
-| [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API |
+|  Class | Description |
+|  --- | --- |
+|  [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
+|  [KibanaRequest](./kibana-plugin-server.kibanarequest.md) |  |
+|  [Router](./kibana-plugin-server.router.md) |  |
+|  [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API |
 
 ## Interfaces
 
-| Interface                                                                        | Description                                                                                                                                        |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [AuthToolkit](./kibana-plugin-server.authtoolkit.md)                             | A tool set defining an outcome of Auth interceptor for incoming request.                                                                           |
-| [CallAPIOptions](./kibana-plugin-server.callapioptions.md)                       | The set of options that defines how API call should be made and result be processed.                                                               |
-| [CoreSetup](./kibana-plugin-server.coresetup.md)                                 | Context passed to the plugins <code>setup</code> method.                                                                                           |
-| [CoreStart](./kibana-plugin-server.corestart.md)                                 | Context passed to the plugins <code>start</code> method.                                                                                           |
-| [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md)                   | Small container object used to expose information about discovered plugins that may or may not have been started.                                  |
-| [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) |                                                                                                                                                    |
-| [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md)                   |                                                                                                                                                    |
-| [HttpServiceStart](./kibana-plugin-server.httpservicestart.md)                   |                                                                                                                                                    |
-| [InternalCoreStart](./kibana-plugin-server.internalcorestart.md)                 |                                                                                                                                                    |
-| [Logger](./kibana-plugin-server.logger.md)                                       | Logger exposes all the necessary methods to log any type of information and this is the interface used by the logging consumers including plugins. |
-| [LoggerFactory](./kibana-plugin-server.loggerfactory.md)                         | The single purpose of <code>LoggerFactory</code> interface is to define a way to retrieve a context-based logger instance.                         |
-| [LogMeta](./kibana-plugin-server.logmeta.md)                                     | Contextual metadata                                                                                                                                |
-| [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md)                   | A tool set defining an outcome of OnRequest interceptor for incoming request.                                                                      |
-| [Plugin](./kibana-plugin-server.plugin.md)                                       | The interface that should be returned by a <code>PluginInitializer</code>.                                                                         |
-| [PluginInitializerContext](./kibana-plugin-server.plugininitializercontext.md)   | Context that's available to plugins during initialization stage.                                                                                   |
-| [PluginsServiceSetup](./kibana-plugin-server.pluginsservicesetup.md)             |                                                                                                                                                    |
-| [PluginsServiceStart](./kibana-plugin-server.pluginsservicestart.md)             |                                                                                                                                                    |
+|  Interface | Description |
+|  --- | --- |
+|  [AuthToolkit](./kibana-plugin-server.authtoolkit.md) | A tool set defining an outcome of Auth interceptor for incoming request. |
+|  [CallAPIOptions](./kibana-plugin-server.callapioptions.md) | The set of options that defines how API call should be made and result be processed. |
+|  [CoreSetup](./kibana-plugin-server.coresetup.md) | Context passed to the plugins <code>setup</code> method. |
+|  [CoreStart](./kibana-plugin-server.corestart.md) | Context passed to the plugins <code>start</code> method. |
+|  [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
+|  [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) |  |
+|  [HttpServiceStart](./kibana-plugin-server.httpservicestart.md) |  |
+|  [InternalCoreStart](./kibana-plugin-server.internalcorestart.md) |  |
+|  [Logger](./kibana-plugin-server.logger.md) | Logger exposes all the necessary methods to log any type of information and this is the interface used by the logging consumers including plugins. |
+|  [LoggerFactory](./kibana-plugin-server.loggerfactory.md) | The single purpose of <code>LoggerFactory</code> interface is to define a way to retrieve a context-based logger instance. |
+|  [LogMeta](./kibana-plugin-server.logmeta.md) | Contextual metadata |
+|  [OnPostAuthToolkit](./kibana-plugin-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
+|  [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
+|  [Plugin](./kibana-plugin-server.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
+|  [PluginInitializerContext](./kibana-plugin-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. |
+|  [PluginsServiceSetup](./kibana-plugin-server.pluginsservicesetup.md) |  |
+|  [PluginsServiceStart](./kibana-plugin-server.pluginsservicestart.md) |  |
 
 ## Type Aliases
 
-| Type Alias                                                                       | Description                                                                                                              |
-| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| [APICaller](./kibana-plugin-server.apicaller.md)                                 |                                                                                                                          |
-| [AuthenticationHandler](./kibana-plugin-server.authenticationhandler.md)         |                                                                                                                          |
-| [ElasticsearchClientConfig](./kibana-plugin-server.elasticsearchclientconfig.md) |                                                                                                                          |
-| [Headers](./kibana-plugin-server.headers.md)                                     |                                                                                                                          |
-| [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md)                   |                                                                                                                          |
-| [OnRequestHandler](./kibana-plugin-server.onrequesthandler.md)                   |                                                                                                                          |
-| [PluginInitializer](./kibana-plugin-server.plugininitializer.md)                 | The <code>plugin</code> export at the root of a plugin's <code>server</code> directory should conform to this interface. |
-| [PluginName](./kibana-plugin-server.pluginname.md)                               | Dedicated type for plugin name/id that is supposed to make Map/Set/Arrays that use it as a key or value more obvious.    |
+|  Type Alias | Description |
+|  --- | --- |
+|  [APICaller](./kibana-plugin-server.apicaller.md) |  |
+|  [AuthenticationHandler](./kibana-plugin-server.authenticationhandler.md) |  |
+|  [ElasticsearchClientConfig](./kibana-plugin-server.elasticsearchclientconfig.md) |  |
+|  [Headers](./kibana-plugin-server.headers.md) |  |
+|  [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) |  |
+|  [OnPostAuthHandler](./kibana-plugin-server.onpostauthhandler.md) |  |
+|  [OnPreAuthHandler](./kibana-plugin-server.onpreauthhandler.md) |  |
+|  [PluginInitializer](./kibana-plugin-server.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>server</code> directory should conform to this interface. |
+|  [PluginName](./kibana-plugin-server.pluginname.md) | Dedicated type for plugin name/id that is supposed to make Map/Set/Arrays that use it as a key or value more obvious. |
+

docs/development/core/server/kibana-plugin-server.onpostauthhandler.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [OnPostAuthHandler](./kibana-plugin-server.onpostauthhandler.md)
+
+## OnPostAuthHandler type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type OnPostAuthHandler<Params = any, Query = any, Body = any> = (request: KibanaRequest<Params, Query, Body>, t: OnPostAuthToolkit) => OnPostAuthResult | Promise<OnPostAuthResult>;
+```

docs/development/core/server/kibana-plugin-server.onpostauthtoolkit.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [OnPostAuthToolkit](./kibana-plugin-server.onpostauthtoolkit.md)
+
+## OnPostAuthToolkit interface
+
+A tool set defining an outcome of OnPostAuth interceptor for incoming request.
+
+<b>Signature:</b>
+
+```typescript
+export interface OnPostAuthToolkit 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [next](./kibana-plugin-server.onpostauthtoolkit.next.md) | <code>() =&gt; OnPostAuthResult</code> | To pass request to the next handler |
+|  [redirected](./kibana-plugin-server.onpostauthtoolkit.redirected.md) | <code>(url: string) =&gt; OnPostAuthResult</code> | To interrupt request handling and redirect to a configured url |
+|  [rejected](./kibana-plugin-server.onpostauthtoolkit.rejected.md) | <code>(error: Error, options?: {`<p/>`        statusCode?: number;`<p/>`    }) =&gt; OnPostAuthResult</code> | Fail the request with specified error. |
+