Security Solution Serverless Plugin

Table of Contents

• Introduction
• Purpose
• Architecture
• Contributing
• License

Introduction

The security_solution_serverless plugin is an internal plugin for Kibana's Security Solution, designed to encapsulate serverless-specific logic. This plugin is only enabled when the application is built for serverless project, keeping the main security_solution plugin clean and agnostic of the offering model.

This plugin contains configuration and code used to create a Serverless Security project.
It leverages universal configuration and other APIs in the serverless plugin to configure Kibana.

Purpose

The primary goal of the security_solution_serverless plugin is to:

• Isolate serverless-specific code and configuration from the main security_solution plugin.
• Enable seamless integration with the serverless environment without affecting the non-serverless build of the Security Solution.
• Provide a modular approach by encapsulating serverless-related functionality, thereby maintaining the codebase's cleanliness and modularity.

Architecture

The security_solution_serverless plugin depends on the main security_solution plugin, it can import code from it thought the use of agnostic packages is preferred, and they interact through the plugin lifecycle contract. This architecture allows the security_solution_serverless plugin to:

• Modify the behavior of the main plugin by providing serverless-specific content.
• Ensure that the security_solution plugin remains offering-agnostic by using APIs for serverless-specific behavior only when necessary.

Plugin Interaction

• Generic Plugin (security_solution): Exposes an API in its plugin lifecycle contract for components and configurations that depend on the offering.
• Serverless Plugin (security_solution_serverless): Utilizes the exposed API to inject or modify the application according to serverless-specific content and logic.
• Other Plugins: Other plugins may also expose contract APIs to configure serverless-specific content for Security.

Example

The following example demonstrates how the security_solution_serverless plugin interacts with the main security_solution plugin via a contract API.

It exposes a setter to the contract API for usersUrl, which is an offering-specific value. The security_solution_serverless plugin uses these APIs to inject the serverless-specific URL into the main plugin.

The PluginContract class in the main Security Solution plugin simplifies the usage of contract APIs, storing the values and providing a getter to the application using the Kibana services context.

security_solution/public/plugin_contract.ts

export class PluginContract {
    usersUrl: string;

    public getStartContract() {
        return {
            setUsersUrl: (url: string) => { 
                this.usersUrl = url;
            }
        };
    }

    public getStartServices() {
        return {
            getUsersUrl: () => this.usersUrl; // available via useKibana().services.getUsersUrl()
        };
    }
}

security_solution_serverless/public/plugin.ts

export class Plugin {

    public start(core: CoreStart, deps: SecuritySolutionServerlessStartDeps) {
        deps.securitySolution.setUsersUrl(deps.cloud.usersAndRolesUrl);
    }
}

Contributing

If you're looking to contribute to this plugin, please follow the standard contribution guidelines of the Security Solution plugin. Ensure that all changes are tested in a serverless environment.

License

This plugin is licensed under the Elastic License. See the LICENSE file for more details.