lula

README

Lula - The Kubernetes Compliance Engine

Lula is a tool written to bridge the gap between expected configuration required for compliance and actual configuration.

Cloud Native Infrastructure, Platforms, and applications can establish OSCAL documents that live beside source-of-truth code bases. Providing an inheritance model for when a control that the technology can satisfy IS satisfied in a live-environment.

This can be well established and regulated standards such as NIST 800-53. It can also be best practices, Enterprise Standards, or simply team development standards that need to be continuously monitored and validated.

Why this approach vs a policy engine?

• Lula is not meant to compete with policy engines - rather augment the auditing and alerting process
• Often admission control processes have a difficult time establishing big picture global context control satisfaction
• Lula is meant to allow modularity and inheritance of controls based upon the components of the system you build

How does it work?

Under the hood, Lula has two primary capabilities; Provider and Domains.

• A Domain is an identifier for where to collect data to be validated
• A Provider is the "engine" performing the validation using policy and the data collected.

In the standard CLI workflow:

• Target a Component-Definition OSCAL file for validation
  • lula validate oscal-component.yaml
• This creates an object in memory for the OSCAL content
• Lula then traverses as required to identify implemented-requirements that contain a Lula Validation Payload
• When the payload has been identified:
  • Lula processes provider to understand which provider to use for validation
    • More than one provider can be used in an OSCAL document
  • Lula processes the domain to understand how data is collected (and which data to collect)
  • Lula collects the data for validation as specified in the payload
  • Lula performs validation of the data collected as specified as policy in the payload

Getting Started

Try it out

Dependencies

• A running Kubernetes cluster
  • Kind
    • kind create cluster -n lula-test
  • K3d
    • k3d cluster create lula-test
• kubectl
• GoLang version 1.22.x

Steps

1. Clone the repository to your local machine and change into the lula directory

   git clone https://github.com/defenseunicorns/lula.git && cd lula
   

2. While in the lula directory, compile the tool into an executable binary. This outputs the lula binary to the bin directory.

   make build
   

3. Apply the ./demo/namespace.yaml file to create a namespace for the demo

   kubectl apply -f ./demo/namespace.yaml
   

4. Apply the ./demo/pod.fail.yaml to create a pod in your cluster

   kubectl apply -f ./demo/pod.fail.yaml
   

5. Run the following command in the lula directory:

   ./bin/lula validate -f ./demo/oscal-component.yaml
   

   The output in your terminal should inform you that the control validated is not-satisfied:

    NOTE  Saving log file to
      /var/folders/f7/8csz3jj97lb8nqp_zv9kh07m0000gn/T/lula-2024-01-24-13-51-58-2247835644.log
     •  UUID: c759a19b-d408-424c-8342-298f45e18b68                                                                                                                                                                                                                   
     •  Status: not-satisfied                                                                                                                                                                                                                                        
     ✔  Validating Implemented Requirement - 42C2FFDC-5F05-44DF-A67F-EEC8660AEFFD                                                                                                                                                                                    
     •  Writing Security Assessment Results to: assessment-results-01-24-2024-13:51:58.yaml
   

   This will also produce an assessment-results file with timestamp - review the findings and observations:

     findings:
       - description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,  quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
         related-observations:
           - observation-uuid: ef12a3bb-fd86-4336-9d28-98d00c7dc26d
         target:
           status:
             state: not-satisfied
           target-id: ID-1
           type: objective-id
         title: 'Validation Result - Component:A9D5204C-7E5B-4C43-BD49-34DF759B9F04 / Control Implementation: A584FEDC-8CEA-4B0C-9F07-85C2C4AE751A / Control:  ID-1'
         uuid: c759a19b-d408-424c-8342-298f45e18b68
     observations:
       - collected: "2024-01-24T13:51:58-08:00"
         description: |
           [TEST] ID-1 - a7377430-2328-4dc4-a9e2-b3f31dc1dff9
         methods:
           - TEST
         relevant-evidence:
           - description: |
               Result: not-satisfied - Passing Resources: 0 - Failing Resources 1
         uuid: ef12a3bb-fd86-4336-9d28-98d00c7dc26d
   

6. Now, apply the ./demo/pod.pass.yaml file to your cluster to configure the pod to pass compliance validation:

   kubectl apply -f ./demo/pod.pass.yaml
   

7. Run the following command in the lula directory:

   ./bin/lula validate -f ./demo/oscal-component.yaml
   

   The output should now show the pod as passing the compliance requirement:

    NOTE  Saving log file to
      /var/folders/f7/8csz3jj97lb8nqp_zv9kh07m0000gn/T/lula-2024-01-24-13-54-19-2423960428.log
     •  UUID: c3e4ccb2-6843-4ec2-a500-559cdd7918d5                                                                                                                                                                                                                   
     •  Status: satisfied                                                                                                                                                                                                                                            
     ✔  Validating Implemented Requirement - 42C2FFDC-5F05-44DF-A67F-EEC8660AEFFD                                                                                                                                                                                    
     •  Writing Security Assessment Results to: assessment-results-01-24-2024-13:54:19.yaml
   

   This will produce a new assessment-results file with timestamp - review the findings and observations:

     findings:
       - description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,  quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
         related-observations:
           - observation-uuid: 84a169a1-74d6-4e26-bbfb-4dfc474c7790
         target:
           status:
             state: satisfied
           target-id: ID-1
           type: objective-id
         title: 'Validation Result - Component:A9D5204C-7E5B-4C43-BD49-34DF759B9F04 / Control Implementation: A584FEDC-8CEA-4B0C-9F07-85C2C4AE751A / Control:  ID-1'
         uuid: c3e4ccb2-6843-4ec2-a500-559cdd7918d5
     observations:
       - collected: "2024-01-24T13:54:19-08:00"
         description: |
           [TEST] ID-1 - a7377430-2328-4dc4-a9e2-b3f31dc1dff9
         methods:
           - TEST
         relevant-evidence:
           - description: |
               Result: satisfied - Passing Resources: 1 - Failing Resources 0
         uuid: 84a169a1-74d6-4e26-bbfb-4dfc474c7790
   

Future Extensibility

• Support for cloud infrastructure state queries

Developing

• Go 1.22.x