Merge branch 'defect/17548'

# -*- mode: python ; coding: utf-8 -*-

#

#   +---------------+

#   | bridgedb.conf |

#   +---------------+

#

# This file uses Python syntax, and is sourced as if it were a .py file. Just

# pretend you're writing Python, and everything will be peachy keen.

#

# This file should live at:

# polyanthum.torproject.org:/srv/bridges.torproject.org/etc/bridgedb.conf

#______________________________________________________________________________

#

# Part of BridgeDB, a Tor bridge distribution system.

#

# :authors: The Tor Project, Inc.

# :license: This file is freely distributed as part of BridgeDB, see LICENSE

#           for details.

# :copyright: (c) 2007-2017 The Tor Project, Inc.

#             (c) 2007-2017, all sentient entities within the AUTHORS file

# :version: 0.3.3

#===============================================================================

#

# CHANGELOG:

# ~~~~~~~~~~

# Changed in version 0.3.3 - 2015-07-22

#   * ADD new options, CSP_ENABLED, CSP_REPORT_ONLY, and CSP_INCLUDE_SELF for

#     setting options related to HTTP(S) Distributor Content Security Policy

#     settings.

#

# Changed in version 0.3.2 - 2015-04-30

#   * CHANGE to using BridgeDB release versions for bridgedb.conf file versions.

#   * ADD support for specifying bridge rotation periods via the

#     EMAIL_ROTATION_PERIOD and HTTPS_ROTATION_PERIOD settings.

#   * ADD a new option, IGNORE_NETWORKSTATUS, which controls if BridgeDB cares

#     whether or not a bridge was present in the BridgeAuthority's

#     networkstatus-bridges file, as well as what information is gleaned from

#     the bridge-networkstatus documents within that file.

#

# Changed in version 0.0.15 - 2015-03-26

#   * ADD new SUPPORTED_TRANSPORTS and DEFAULT_TRANSPORT settings.

#

# Changes in version 0.0.14 - 2015-02-22

#   * ADD new OpenPGP-related options:

#        - EMAIL_GPG_HOMEDIR

#        - EMAIL_GPG_PRIMARY_KEY_FINGERPRINT

#        - EMAIL_GPG_PASSPHRASE

#        - EMAIL_GPG_PASSPHRASE_FILE

#   * REMOVE old OpenPGP signing key file option, EMAIL_GPG_SIGNING_KEY.

#

# Changes in version 0.0.13 - 2015-02-20

#   * ADD NO_DISTRIBUTION_COUNRIES option for refusing to distribute bridges

#     whose primary ORAddress is geolocated to any of some certain countries.

#

# Changes in version 0.0.12 - 2015-02-06

#   * ADD a dictionary of TASKS to be run and the intervals at which they

#     should be repeated.

#

# Changes in version 0.0.11 - 2014-07-06

#   * ADD EMAIL_BLACKLIST and EMAIL_FUZZY_MATCH settings.

#

# Changes in version 0.0.10 - 2014-06-06

#   * Support requiring distribution of bridges with the "Running" flag.

#

# Changes in version 0.0.9 - 2014-06-06

#   * ADD EMAIL_WHITELIST setting.

#

# Changes in version 0.0.8 - 2014-05-14

#   * CHANGE RECAPTCHA_PRIV_KEY to RECAPTCHA_SEC_KEY.

#

# Changes in version 0.0.7 - 2014-03-31

#   * ADD new settings for tracing function calls and thread info within logged

#     messages: LOG_THREADS, LOG_TRACE, and LOG_TIME_FORMAT.

#

# Changes in version 0.0.6 - 2014-03-28

#   * CHANGE gimp-captchas to be the norm.

#   * ADD bucket for support team.

#

# Changes in version 0.0.5 - 2014-02-27

#   * ADD GIMP_CAPTCHA_ENABLED, GIMP_CAPTCHA_DIR, GIMP_CAPTCHA_HMAC_KEYFILE,

#     and GIMP_CAPTCHA_RSA_KEYFILE settings (see #10809).

#   * Decrease email share.

#   * Whitelist the public IP address of bridges.torproject.org in

#     RECAPTCHA_REMOTE_IP setting.

#

# Changes in version 0.0.4 - 2014-01-24

#   * ADD COLLECT_TIMESTAMPS option (see #10724). Set it to False for the

#     staging instance (etc/test-bridgedb.conf), and True for the production

#     server (etc/bridgedb.conf).

#

# Changes in version 0.0.3 - 2014-01-17

#   * UPDATE config from bridgedb.git/bridgedb.conf, without changing any of the

#     settings.

#

# Changes in version 0.0.2 - 2014-01-17

#   * ADD missing settings, EMAIL_GPG_SIGNING_ENABLED and EMAIL_GPG_SIGNING_KEY.

#

# Changes in version 0.0.1 - 2013-08-30

#   * ADD version of config file in use on ponticum.

#     - Two config variables, RECAPTCHA_PUB_KEY and RECAPTCHA_PRIV_KEY, have

#       been removed, they can be found in:

#       patches/001-bridgedb-conf-recaptcha-vars.patch.

#   * CLEANUP the config file slightly (such as adding these headers) and

#     fixing the linewraps. No other variables were touched.

#

#===============================================================================

#===========================#

#  General-purpose options  #

#___________________________#

#----------------

# Required Files \  You'll want to make sure that these ones exist!

# once we have the vidalia/tor interaction fixed for everbody.

EMAIL_INCLUDE_FINGERPRINTS = True

#

# Configuration options for OpenPGP signing and encryption

# ------------------------------------------------------------------------------

# Should we sign all email responses to clients with the key specified by

# EMAIL_GPG_PRIMARY_KEY_FINGERPRINT (or one of its subkeys)?

EMAIL_GPG_SIGNING_ENABLED = True

# The directory, relative to BridgeDB's runtime directory, in which to store

# OpenPGP keyrings and associated files.

EMAIL_GPG_HOMEDIR = '.gnupg'

# This should be a 40-character hexadecimal string containing the OpenPGP

# fingerprint (without spaces) of the default primary key to use.  The key

# should be capable of both signing and encryption, or have subkeys capable of

# such.

#

# The default primary key fingerprint below is BridgeDB's online signing keypair:

EMAIL_GPG_PRIMARY_KEY_FINGERPRINT = 'DF811109E17C8BF134B5EEB68DC43A2848821E32'

# If the key referred to by EMAIL_GPG_PRIMARY_KEY_FINGERPRINT requires a

# passphrase for signing or encryption, then the passphrase may be given in

# the EMAIL_GPG_PASSPHRASE option (as a string), or it may be contained within

# the file pointed to by EMAIL_GPG_PASSPHRASE_FILE.  Currently, only one

# passphrase is supported, so if the key specified by

# EMAIL_GPG_PRIMARY_KEY_FINGERPRINT has multiple subkeys, those subkeys MUST

# all have the same passphrase.

#

# If EMAIL_GPG_PASSPHRASE_FILE is used, and the filepath is not absolute, the

# path is interpreted as being relative to BridgeDB's runtime directory.

# (Note: be sure not to put any newlines after the phassphrase in the

# EMAIL_GPG_PASSPHRASE_FILE, or else they will be interpreted as part of the

# passphrase.)

#

# There are currently no safety checks on the permissions of either this

# configuration file or the EMAIL_GPG_PASSPHRASE_FILE, so beware and use at

# your own risk.

#

# If both EMAIL_GPG_PASSPHRASE and EMAIL_GPG_PASSPHRASE_FILE are ``None``,

# then it is assumed that the key specified by

# EMAIL_GPG_PRIMARY_KEY_FINGERPRINT does not require a passphrase.

EMAIL_GPG_PASSPHRASE = None

EMAIL_GPG_PASSPHRASE_FILE = '.gnupg/passphrase'

#-------------------------------

# Hashring Allocation Options   \

#------------------------------------------------------------------------------