Skip to main content

Tool to Convert Sendmail Alias Files to Proofpoint LDIF Format

Project description

Sendmail Alias File to Proofpoint LDIF Converter

PyPI Downloads
Tool to Convert Sendmail Alias Files to Proofpoint LDIF Format

Requirements:

  • Python 3.9+

Installing the Package

You can install the tool using the following command directly from GitHub.

pip install git+https://github.com/pfptcommunity/sma2ldif.git

or can install the tool using pip.

# When testing on Ubuntu 24.04 the following will not work:
pip install sma2ldif

If you see an error similar to the following:

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.

    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.

    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.

    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

You should use install pipx or you can configure your own virtual environment and use the command referenced above.

pipx install sma2ldif

Use Cases

In certain Proofpoint on Demand setups, valid recipient addresses may not be listed in Azure, LDAP, or Active Directory. Some organizations use aliases on an internal Sendmail system to direct messages to mailing lists or other destinations. This tool converts Sendmail alias configurations into LDIF format for import into a Proofpoint on Demand cluster. The aliases are added as contact lists, enabling recipient verification without disrupting custom email workflows. An example of a converted alias entry is provided below.

dn: 1002d@acme.com
uid: 9cf8803e-fc8c-5d4a-8381-e59b33eaa8a5
description: Auto generated by sma2ldif
givenName: 1002d
sn: sma2ldif
profileType: 1
mail: 1002d@acme.com

The the example above was generated using the following arguments:

sma2ldif -i /etc/aliases -o /tmp/aliases.ldif -d acme.com

If other domains are listed with the -d argument as shown below.

sma2ldif -i /etc/aliases -o /tmp/aliases.ldif -d acme.com, example.com, foo.com

The result would look similar to the following.

dn: 1002d@acme.com
uid: 9cf8803e-fc8c-5d4a-8381-e59b33eaa8a5
description: Auto generated by sma2ldif
givenName: 1002d
sn: sma2ldif
profileType: 1
mail: 1002d@acme.com
proxyAddresses: 1002d@example.com
proxyAddresses: 1002d@foo.com

Usage

usage: sma2ldif --alias-file <aliases> --ldif-file <ldif> -d <domain>
                [<domain> ...] [-g <group> [<group> ...]] [-e]
                [--log-level {debug,info,warning,error,critical}]
                [-l LOG_FILE] [-s LOG_MAX_SIZE] [-c LOG_BACKUP_COUNT] [-h]

Convert Sendmail alias files to Proofpoint LDIF format.

Required Arguments:
  --alias-file <aliases>                                  Path to the input
                                                          Sendmail aliases
                                                          file.
  --ldif-file <ldif>                                      Path to the output
                                                          LDIF file.
  -d <domain> [<domain> ...], --domains <domain> [<domain> ...]
                                                          List of domains for
                                                          alias processing
                                                          (first domain is
                                                          primary).

Optional Arguments:
  -g <group> [<group> ...], --groups <group> [<group> ...]
                                                          List of memberOf
                                                          groups for LDIF
                                                          entries (default:
                                                          none).
  -e, --expand-proxy                                      Expand
                                                          proxyAddresses into
                                                          unique DN entries.
  --log-level {debug,info,warning,error,critical}         Set the logging
                                                          level (default:
                                                          warning).
  -l LOG_FILE, --log-file LOG_FILE                        Set the log file
                                                          location (default:
                                                          sma2ldif.log).
  -s LOG_MAX_SIZE, --log-max-size LOG_MAX_SIZE            Maximum size of log
                                                          file in bytes before
                                                          rotation (default:
                                                          10485760).
  -c LOG_BACKUP_COUNT, --log-backup-count LOG_BACKUP_COUNT
                                                          Number of backup log
                                                          files to keep
                                                          (default: 5).
  -h, --help                                              Show this help
                                                          message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sma2ldif-0.0.3.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sma2ldif-0.0.3-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file sma2ldif-0.0.3.tar.gz.

File metadata

  • Download URL: sma2ldif-0.0.3.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sma2ldif-0.0.3.tar.gz
Algorithm Hash digest
SHA256 7d4a97cb793876aaf5103c1fc91551c4ea5dd6997006f3dada67ab4f7f2be778
MD5 de5d5d6b220e08ea1c1e12ea0d9950a4
BLAKE2b-256 84f31b439693fdc05a28ba3c2df16f1b72dedc77a6e94b71e76cfb1a92ca54ec

See more details on using hashes here.

File details

Details for the file sma2ldif-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: sma2ldif-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sma2ldif-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d13ad484a60b9de3a45274d4e75a11e151b58ca6d1404b6a957986dd5ca7b808
MD5 a26d125740d71d8bfcb182f0f3db0436
BLAKE2b-256 203b3849135030f45013df33a09fc94d2fb88b3c3f587b0254a68f27e28667ef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page