xrobau/spfcheck

Checks an IP address against a domain's SPF record

1.2.0 2022-03-16 02:31 UTC

Requires

• php: >=5.4
• purplepixie/phpdns: ^2.0
• symfony/http-foundation: *

Requires (Dev)

• phpunit/phpunit: ^9
• satooshi/php-coveralls: ~1.0
• symfony/phpunit-bridge: ^4.2 || 5.*
• symfony/yaml: ~2.1

MIT

• Mikael Peigney
• Brian Tafoya
• Rob Thomas

README

Simple library to check an IP address against a domain's SPF record

This is an updated fork of mika56/spfcheck, with only minor changes.

Installation

This library is available through Composer. Run composer require xrobau/spfcheck or add this to your composer.json:

{
  "require": {
    "xrobau/spfcheck": "^1"
  }
}

Usage

Create a new instance of SPFCheck. The constructor requires a DNSRecordGetterInterface to be passed. Currently, you have two options:

• DNSRecordGetter which uses PHP's DNS functions to get data
• DNSRecordGetterDirect which uses the PHP DNS Direct Query Module to get data.

<?php
use Mika56\SPFCheck\SPFCheck;
use Mika56\SPFCheck\DNSRecordGetter;

require('vendor/autoload.php');

$checker = new SPFCheck(new DNSRecordGetter()); // Uses php's dns_get_record method for lookup.
var_dump($checker->isIPAllowed('127.0.0.1', 'test.com'));

// or

$checker = new SPFCheck(new DNSRecordGetterDirect("8.8.8.8")); // Uses phpdns, allowing you to set the nameserver you wish to use for the dns queries.
var_dump($checker->isIPAllowed('127.0.0.1', 'test.com'));

Return value is one of SPFCheck::RESULT_PASS, SPFCheck::RESULT_FAIL, SPFCheck::RESULT_SOFTFAIL, SPFCheck::RESULT_NEUTRAL, SPFCheck::RESULT_NONE, SPFCheck::RESULT_PERMERROR, SPFCheck::RESULT_TEMPERROR

Missing features

A few features are still missing from this library at the moment. Here's a partial list of those features:

• Section 7 of RFC7208 on macros

You are very welcome to submit a pull request adding even part of those features.