Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spf-tools/spf-tools
Shell scripts for taming the SPF (Sender Policy Framework) records in order to fight 10-maximum-DNS-look-ups limit.
https://github.com/spf-tools/spf-tools
continuous-integration dns posix-sh sender-policy-framework shell spf spf-records
Last synced: 3 months ago
JSON representation
Shell scripts for taming the SPF (Sender Policy Framework) records in order to fight 10-maximum-DNS-look-ups limit.
- Host: GitHub
- URL: https://github.com/spf-tools/spf-tools
- Owner: spf-tools
- License: apache-2.0
- Created: 2014-10-01T09:49:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T17:31:53.000Z (9 months ago)
- Last Synced: 2024-05-15T13:41:44.878Z (6 months ago)
- Topics: continuous-integration, dns, posix-sh, sender-policy-framework, shell, spf, spf-records
- Language: Shell
- Homepage:
- Size: 305 KB
- Stars: 174
- Watchers: 27
- Forks: 64
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
_| | |
__| __ \ | __| _ \ _ \ | __|
\__ \ | | __|_____| | ( | ( | |\__ \
____/ .__/ _| \__|\___/ \___/ _|____/
_|
# SPF-tools
[![Join the chat at https://gitter.im/jsarenik/spf-tools][gitter-img]][gitter]
Simple tools for keeping the SPF TXT records tidy in order to fight
[10 maximum DNS look-ups](http://serverfault.com/questions/584708).
## Release notes
### 2019/10 - new domain spf-tools.eu.org
Domain name spf-tools.eu.org is used for testing now.
### 2016/11 - new records on output
spf-tools since version spf-tools/spf-tools@f4f51f7 do not
output merely `ip4` and `ip6` records, but also keep original `ptr`
and `exists` ones.
## General Usage
Your original TXT record which causes more than 10 DNS look-ups
should be saved as an otherwise unused subdomain TXT record
(e.g. `spf-orig.spf-tools.eu.org`).
Create a configuration file:
cat > ~/.spf-toolsrc < ip4:207.68.169.173/30
> ip4:207.68.169.175/30
> ip4:65.55.238.129/26
> EOF
ip4:207.68.169.172/30
ip4:207.68.169.172/30
ip4:65.55.238.128/26
### simplify.sh
This script takes out individual IPv4 addresses which are already
contained in CIDR ranges.
$ ./simplify.sh < ip4:192.168.0.1
> ip4:192.168.0.0/24
> EOF
ip4:192.168.0.0/24
### cloudflare.sh
Dependencies: [jq](https://stedolan.github.io/jq/),
[awk](https://www.gnu.org/software/gawk/),
[sed](https://www.gnu.org/software/sed/),
[grep](https://www.gnu.org/software/grep/)
Script to update pre-existing TXT SPF records for a domain according
to the input in DNS zone format using CloudFlare's API.
To use this script, file `.spf-toolsrc` in `$HOME` directory should
contain `TOKEN` variable definition which is then used
to connect to CloudFlare API. The file should also contain `DOMAIN`
and `ORIG_SPF` variables which stand for the target SPF domain
(e.g. `spf-tools.eu.org`) and original SPF record with includes
(e.g. `spf-orig.spf-tools.eu.org`) in order to use `runspftools.sh`
without modifying the script.
The script is written against v4 of https://api.cloudflare.com/
The only needed permissions for a custom API token are:
- Zone.Zone: Read
- Zone.DNS: Edit
Usage:
./despf.sh | ./normalize.sh | ./simplify.sh | ./iprange.sh | ./cloudflare.sh
### route53.sh
Dependencies: [jq](https://stedolan.github.io/jq/),
[aws](https://aws.amazon.com/cli/),
[awk](https://www.gnu.org/software/gawk/),
[sed](https://www.gnu.org/software/sed/),
[grep](https://www.gnu.org/software/grep/)
```
Usage: route53.sh [OPTION]... [HOSTED_ZONE_ID]
Script to update pre-existing TXT SPF records for
a domain according to the input in DNS zone format.
Available options:
-t TTL set Time To Live for DNS records
-a TXT RECORD set aditional TXT record to domain (can be used multiple times)
Default values:
TTL = 300
```
Script to update pre-existing TXT SPF records for a domain according
to the input in DNS zone format.
The AWS CLI can be configured using `~/.aws/credentials` or using
environment variables: `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
(find more details in [Configuring the AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment)
documentation.
Example:
./despf.sh | ./simplify.sh | ./mkblocks.sh | \
./route53.sh -a "google-site-verification=deadbeef" DEADBEEF
### iprange.sh
Extra dependencies: [iprange](https://github.com/firehol/iprange)
This script optimizes the IPv4 address block output (similar to, but
more than `simplify.sh` because it can join multiple networks into
one bigger).
Usage:
./despf.sh | ./iprange.sh
Example:
$ ./despf.sh cont.spf-tools.eu.org
ip4:13.111.0.0/24
ip4:13.111.1.0/24
ip4:13.111.2.0/24
ip4:13.111.3.0/24
$ ./despf.sh cont.spf-tools.eu.org | ./iprange.sh
ip4:13.111.0.0/22
## Putting it all together
./despf.sh | ./normalize.sh | ./simplify.sh | ./iprange.sh \
| ./mkblocks.sh | ./xsel.sh
## Free Ad
As we are successfully using a free eu.org domain, we are proud to
spread the word: Free domains: http://www.eu.org/
## Links
* https://dmarcian.com/spf-survey/spf.spf-tools.eu.org
* https://dmarcian.com/spf-survey/spf-orig.spf-tools.eu.org
* http://www.kitterman.com/spf/validate.html
* http://serverfault.com/questions/584708
* http://www.openspf.org/SPF_Record_Syntax
* http://tools.ietf.org/html/rfc7208#section-5.5
* http://tools.ietf.org/html/rfc7208#section-14.1
* https://space.dmarcian.com/too-many-dns-lookups/
* https://nic.eu.org/
## License
Copyright 2015-2019 spf-tools team (see AUTHORS)
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.
[gitter-img]: https://badges.gitter.im/Join%20Chat.svg
[gitter]: https://gitter.im/jsarenik/spf-tools