Forge Home

9,332 downloads

9,332 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.0 (latest)
released Dec 4th 2014
This version is compatible with:

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'fortin-tor', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add fortin-tor
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install fortin-tor --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: tor, tor-client

Documentation

fortin/tor — version 0.1.0 Dec 4th 2014

The default include sets up Tor as a basic non-exit relay listening on port 9001

include 'tor'

You can specify the default ORPort

class {'tor':
  orport => 443,
}

You can specify your own contact details with 'nickname' and 'contact' parameters

class {'tor':
  nickname => 'whatever',
  contact  => '0xFFFFFF Whatever <whatever@example.com>',
}

If you want it to advertise directory services, specify also the DirPort parameter (defaults to 0)

class {'tor':
  nickname => 'whatever',
  contact  => '0xFFFFFF Whatever <whatever@example.com>',
  dirport  => 'auto',
}

You can also use the the official Tor APT repository so to have the most recent stable version, but you need puppetlabs/apt module for that to work.

class {'tor':
  nickname        => 'whatever',
  contact         => '0xFFFFFF Whatever <whatever@example.com>',
  enable_apt_repo => true,
}

If you need to override any configuration value, you can always provide them as an array (custom_config parameter)

class {'tor':
  nickname        => 'whatever',
  contact         => '0xFFFFFF Whatever <whatever@example.com>',
  enable_apt_repo => true,
  custom_config   => [
    'AccountingMax 1TB',
    'MaxAdvertisedBandwidth 1MB',
    '...',
  ],
}

To remove it safely

class {'tor':
  ensure => absent,
}

If you want it to be an exit relay, you have a few default options.

You can use reduced exit policies as suggested here

class {'tor':
 nickname   => 'whatever',
 contact    => '0xFFFFFF Whatever <whatever@example.com>',
 exit_relay => 'reduced',
}

You can provide your own custom list of exit policies

class {'tor':
  nickname          => 'whatever',
  contact           => '0xFFFFFF Whatever <whatever@example.com>',
  exit_relay        => 'custom',
  exit_custom_rules => [
    'accept *:443',
    'accept *:80',
    'accept ...',
    'reject *:*'
  ]
}

Finally, you can remove any Exit Policy filter and make it a 'wide-open' relay

class {'tor':
 nickname   => 'whatever',
 contact    => '0xFFFFFF Whatever <whatever@example.com>',
 exit_relay => 'wide-open',
}

NOTE: any other value of exit_relay will set it as a non exit relay (i.e., ExitPolicy reject *:*)