smash-tor

Release 3.2.0

This module manages Tor, making sure it is installed, running, allows for configuration of relays, hidden services, exit policies, etc. With it, you should be able to manage any type of Tor deployment.

Repository Puppet Download

License
GPL-3.0
Install
puppet module install smash-tor --version 3.2.0

Documentation

tor

Table of Contents

  1. Description
  2. Setup
  3. Functions
  4. Facts
  5. Reference
  6. Development

Description

This module manages tor and is mainly geared towards people running it on servers. With this module, you should be able to manage most, if not all of the functionalities provided by tor, such as:

  • relays
  • bridges and exit nodes
  • onion services
  • exit policies
  • transport plugins

Setup

Setup Requirements

This module needs:

Explicit dependencies can be found in the project's metadata.json file.

Getting started

class { 'tor': } will install tor with a default configuration. Chances are you will want to configure Tor in a certain way. This is accomplished declaring one or more of the tor::daemon defined types.

For example, this will configure a tor bridge relay running on port 8080:

  tor::daemon::relay {
    'MyNickname':
      bridge_relay     => true,
      port             => 8080,
      address          => '1.1.1.1',
      bandwidth_rate   => 12500,
      bandwidth_burst  => 12500,
      contact_info     => 'Foo Bar <foo@bar.com>',
  }

Functions

This module comes with 2 functions specific to tor support. They require the base32 gem to be installed on the master or wherever they are executed.

onion_address

This function takes a 1024bit RSA private key as an argument and returns the onion address for an onion service for that key.

At the moment, this function does not support v3 onions.

generate_onion_key

This function takes a path (on the puppet master!) and an identifier for a key and returns an array containing the matching onion address and the private key. The private key either exists under the supplied path/key_identifier or is being generated on the fly and stored under that path for the next execution.

At the moment, this function does not support v3 onions.

Facts

tor_hidden_services

This fact gives you a list of the hidden services you are running.

Reference

The full reference documentation for this module may be found at on GitLab Pages.

Alternatively, you may build yourself the documentation using the puppet strings generate command. See the documentation for Puppet Strings for more information.

Development

This module's development is tracked on GitLab. Please submit issues and merge requests on the shared-puppet-modules-group/tor project page.

Stats

Dependencies
3
Dependent packages
0
Dependent repositories
0
Total releases
12
Latest release
First release
Stars
3
Forks
4
Contributors
0
SourceRank
9

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

3.2.0
3.1.1
3.1.0
3.0.0
2.3.0
2.2.0
2.1.0
2.0.1
2.0.0
1.1.0
See all 12 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2021-05-07 17:36:53 UTC

Login to resync this project