1
0
mirror of https://github.com/jschauma/spf.git synced 2024-05-09 09:54:51 +00:00

11 Commits

Author SHA1 Message Date
Randolf Richardson 張文道
0800192fa2 Update README.md
Updated sample output for sample SPF analysis of github.com to reflect changes to updated code, plus various other changes.  (I don't know where else to add these, so I saved them here again for easier copying to the right template files later.)
2024-02-06 23:20:46 -08:00
Randolf Richardson 張文道
907cbec2b8 Update README.md 2024-02-04 06:54:32 -08:00
Randolf Richardson 張文道
b13d00fb21 Update README.md 2024-02-04 06:51:17 -08:00
Jan Schaumann
5093798868 add sample output 2022-09-19 08:55:32 -04:00
Jan Schaumann
4483ea9d04 expand install instructions 2022-09-06 23:57:35 -04:00
Jan Schaumann
0edffae0a3 Merge branch 'main' of github.com:jschauma/spf 2022-09-06 23:50:46 -04:00
Jan Schaumann
f3e3aa9ec0 add '-p' option to pass a policy to expand 2022-09-02 17:09:25 -04:00
patpro
dd79b80311 simple dependencies handling for FreeBSD 2022-09-01 07:59:08 +02:00
patpro
8b76315615 provides dependancies instruction for FreeBSD 2022-09-01 07:56:22 +02:00
Royce Williams
866dff0937 add apt install howto 2022-08-30 17:14:55 -08:00
Jan Schaumann
6f8fcff364 Initial import of the 'spf' utility.
See https://www.netmeister.org/blog/spf.html for a longer discussion.

NAME
     spf - report on the given domain's use of SPF

SYNOPSIS
     spf [-Vhjv] [-r address] domain

DESCRIPTION
     The spf tool allows you to inspect the Sender Policy Framework DNS records
     for the given domain.

OPTIONS
     The following options are supported by spf:

     -V		 Print version information and exit.

     -h		 Display help and exit.

     -j		 Generate output in json format.

     -r address	 Explicitly query this resolver.

     -v		 Be verbose.  Can be specified multiple times.

DETAILS
     The Sender Policy Framework (SPF) defined in RFC7208 specifies the format
     for the SPF DNS entries a domain may choose to apply.  These entries can
     range from the straight forward to the complex, harboring certain surprises
     or unintenionally obscuring important information, such as when one domain
     includes the SPF records of another domain.

     spf can be used to report on the comprehensive ruleset derived from the DNS
     record.  It does that by counting CIDRs, resolving e.g., MX records, and
     recursively looking up SPF records of any included domains.

EXAMPLES
     The following examples illustrate common usage of this tool.

     To report on the SPF records for the domain netmeister.org:

	   spf netmeister.org

     To query Quad9's public resolver for the same SPF records and report the
     results in json format:

	   spf -r 2620:fe::fe -j netmeister.org

EXIT STATUS
     The spf utility exits 0 on success, and >0 if an error occurs.

SEE ALSO
     dig(1)

HISTORY
     spf was originally written by Jan Schaumann <jschauma@netmeister.org> in
     July 2022.

BUGS
     Please file bugs and feature requests by emailing the author.
2022-08-30 18:25:43 -04:00