faraday Cookbook

Installs and configures Faraday - A collaborative penetration testing tool!

Requirements

Cookbooks

• poise-python - https://supermarket.chef.io/cookbooks/poise-python
• cron - https://supermarket.chef.io/cookbooks/cron

Services

• couchdb

Platforms

The following platforms and versions are tested and supported using Opscode's test-kitchen.
- Debian 7
- Debian 8

Attributes

faraday::default

All others attributes in ['faraday']['config'] namespace will generate dynamically the
configuration file as XML format in $HOME/.faraday/config/config.xml.

Use the ['faraday']['config_attrs'] namespace to set xml attributes. See [default attributes](attributes/default.rb) for more details.

Usage

Installation

You have two ways to install Faraday:

faraday::package

Use faraday::package to only install python-faraday package:

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday::package]"
  ]
}

faraday::sources

Include faraday::sources in your node's run_list to install faraday and its requirements from source:

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday::sources]"
  ],
  "attributes": {
    "faraday": {
      "git_reference": "v1.0.20",
      "install_dir": "/opt/faraday-1.0.20"
    }
  }
}

The faraday::default recipe will only install package dependencies. It is included in faraday::package and faraday::sources.

faraday::gtk

If you want to use the GTK GUI, you can include faraday::gtk to install extra dependencies.

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday]",
    "recipe[faraday::gtk]"
  ]
}

Configuration

faraday::config

Include faraday::config in your node's run_list to configure faraday for a user:

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday::config]"
  ],
  "attributes": {
    "faraday": {
      "user": "my_user",
      "config": {
        "couch_uri": "http://127.0.0.1:5984",
        "last_workspace": "my_workspace"
      }
    }
  }
}

faraday::cscan

Include faraday::cscan in your node's run_list to configure default continuous scanning:

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday::cscan]"
  ],
  "attributes": {
    "faraday": {
      "cscan": {
        "config": {
          "couch_uri": "https://couchdb-host:6984",
          "last_workspace": "cscan_workspace"
        },
        "ips": ["192.168.0.1"],
        "websites": ["http://192.168.0.1"]
      }
    }
  }
}

faraday::service

Include faraday::service in your node's run_list to configure faraday as a server (Experimental):

{
  "name":"my_node",
  "run_list": [
    "recipe[faraday]",
    "recipe[faraday::service]"
  ],
  "attributes": {
    "faraday": {
      "git_reference": "v1.0.20",
      "install_dir": "/opt/faraday",
      "python_runtime": "2",
      "service": {
        "RUN": "true",
        "NAME": "faraday-server",
        "USER": "faraday",
        "INSTALL_DIR": "/opt/faraday",
        "DAEMON_ARGS": "faraday.py --gui=no-gui --port 31337"
      },
      "config": {
        "version": "1.0.20",
        "couch_uri": "http://127.0.0.1:5984"
      }
    }
  }
}

Custom resources

faraday_config

This LWRP can be used to deploy many faraday configuration.

Actions

Attributes

Example

faraday_config 'sliim' do
  config last_workspace: 'sliim-corp'
  end

faraday_config 'sliim' do
  action :delete
  file 'user.xml'
end

faraday_cscan

Install and configure a continuous scanning directory.

Actions

Attributes

Example

faraday_cscan 'local' do
  action [:install, :configure]
  ips ['10.0.1.2',
       '10.0.1.3',
       '10.0.1.4']
  crond hour: 13,
        minute: 37,
        weekday: 5,
        user: 'faraday',
        mailto: 'you@gmail.com',
        command: ./cscan.py -p nmap.sh >> cron.log 2>&1 && mv output/* /opt/faraday/.faraday/report/cscan-local

end

Tests

• First, install dependencies:
  
  bundle install

• Run Checkstyle and ChefSpec:
  
  bundle exec rake

• Run Kitchen tests:
  bundle exec rake kitchen

If you have Docker, you can use the kitchen driver which is faster:
export KITCHEN_YAML=.kitchen.docker.yml

bundle exec rake kitchen

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors

Authors: Sliim sliim@mailoo.org

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.