Skip to content

Utility Modules

Jump to bottom Edit New page
Jjk422 edited this page Aug 4, 2016 · 5 revisions

Table of contents

What are utilities?

Utilities, in relation to SecGen, are secure programs that are not linked to a network service socket.
Utilities refer to programs that add extra depth to the generated image, for example Java or Wireshark.

What are utility modules?

Utility modules are SecGen modules that install and configure secure utilities on the generated virtual machine.
Unlike services, utilities are not installed on network service sockets, thus can only be accessed from within the generated machine itself.
Utility modules are created to add more depth and complexity to generated machines, as well as ensuring the installed utilities do not inherently create more vulnerabilities.

Where do secure network socket services go?

Networked services can be found in the service modules directory.

Where are utility modules stored?

Utility modules are stored in the utilities directory, a simplified SecGen file structure to the utilities directory is below:

/SecGen
  /modules
    /utilities

How is the utilities directory structured?

The utilities folder is structured as shown below:

/utilities
  /unix
    /{utility_type}
      /{utility_name}
      /{utility_name}
  /windows
    /{utility_type}
      /{utility_name}
      /{utility_name}

{utility_type}:  
The utility module type, e.g. languages
  
{utility_name}:  
The name of the utility module

What do utility modules actually contain?

Utility modules have the following structure:

/{utility_name}
  /examples
    /...
  /files
    /example.file
  /lib
    /...
  /manifests
    /install.pp
    /config.pp
    /service.pp
  /spec
    /...
  /templates
    /example.erb
  /{utility_name}.pp
  /secgen_metadata.xml

{utility_name}:  
The name of the utility module

More information on the different files and directories plus how they are used can be found in the module development overview.

A full overview of SecGen's module structure can be found here.

What does secgen_metadata.xml actually contain?

The secgen_metadata.xml files for the utility modules are based on following structure:
Minimal utility secgen_metadata.xml file

<?xml version="1.0"?>
<utility xmlns="http://www.github/cliffe/SecGen/utility"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://www.github/cliffe/SecGen/utility">

         <name>””</name>
         <author>””</author>
         <module_license>MIT // Apache v2</module_license>
         <description>””</description>
         <type>””</type>
         <platform>linux // unix // windows</platform>
</utility>

Utility secgen_metadata.xml file with all available values

<?xml version="1.0"?>
<utility xmlns="http://www.github/cliffe/SecGen/utility"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://www.github/cliffe/SecGen/utility">

         <name>””</name>
         <author>””</author>
         <module_license>MIT // Apache v2</module_license>
         <description>””</description>
         <type>””</type>
         <platform>linux // unix // windows</platform>
  
         <!--optional details-->
         <reference>””</reference>
         <software_name>””</software_name>
         <software_license>””</software_license>
         
         <!--Conflicts ensure no duplicate software installations-->
         <conflict>
                  <software_name>””</software_name>
                  <conflict>
                  <module_path>””</module_path>
                  <name>””</name>
                  <author>””</author>
                  <module_license>””</module_license>
                  <description>””</description>
                  <type>””</type>
                  <platform>linux // unix // windows</platform>
                  <reference>””</reference>
                  <software_name>””</software_name>
                  <software_license>””</software_licence>
         </conflict>

         <!--Requires ensures all prerequisite modules installed-->
         <requires>
                  <module_path>””</module_path>
                  <name>””</name>
                  <author>””</author>
                  <module_license>””</module_licence>
                  <description>””</description>
                  <type>””</type>
                  <platform>linux // unix // windows</platform>
                  <reference>””</reference>
                  <software_name>””</software_name>
                  <software_license>””</software_license>
         </requires>
</utility>

A template structure of the utility modules secgen_metadata.xml can be found here.

Where can I get new utility modules from?

New utility modules can be created via importing puppet modules from places like puppetforge, and then modifying them into SecGen's module structure.

How do I import utilities from puppetforge?

SecGen uses Puppet to provision its modules to the generated virtual machine. This guide will detail the development process and provisioning of the Python puppet module found on the Puppet Forge

Although this tutorial uses the linux terminal, other ways exists of doing the same steps. Allowing for terminal commands however, removes software and gui requirements for users.

Download Puppet Module

Puppet modules can be found on the Puppet Forge - The example used in this tutorial is zlieslie/python.

First, download the puppet module to your development machine

wget https://forge.puppet.com/v3/files/zleslie-python-2.2.1.tar.gz

Next, create a directory in the correct directory path for your selected module, in this case we will be installing a secure utility, so it will be under the /utility directory.

This utility can be stored in the languages subdirectory

mkdir SecGen/modules/services/unix/languages

However, if no existing subdirectory exists for the utility type, the subdirectory can be generatred with this command

mkdir SecGen/modules/services/unix/{new_utility_type}

Next, unzip the contents of the puppet module downloaded earlier, into the newly created directory

tar -xvf zleslie-python-2.2.1.tar.gz -C ~/{path_to_SecGen}/SecGen/modules/utilities/unix/languages/

Finally, rename the extracted file into a simpler name

mv zleslie-python-2.2.1 python

Now your services directory structure should look something like this

/SecGen
  /modules
    /utilities
      /unix
        /languages
          /python
            /lib
            /spec
            /manifests
            /templates
            /tests

Manifest file

In order to execute the module, a manifest file will need to be created, this manifest should have the same name as the module.

The puppet manifest should call the class for the module, this will differ between puppet modules and is usually included in the module documentation, for this example, we are going to install apache with the default configuration

class { 'python': }

SecGen_Metadata.xml

The SecGen metadata is used to store information about the puppet module that is used in the SecGen module selection process, see the current XML Schema for an up-to-date representation as to what this should look like.

Testing the module

The module can be tested by strictly specifying that this module be included in the scenario.xml

<utility type="languages" name="python"></utility>

or

<utility module_path="modules/utilities/unix/languages/python"></utility>

When SecGen is run, there should be some verbose output from vagrant specifying that python has been installed.

How do I create my own utility modules

Caution: This wiki is still in development, therefore some parts may not be fully updated, finished or may be missing information

Add a custom sidebar
Clone this wiki locally