Skip to content

Commit

Permalink
Release v1.2.5 (#22)
Browse files Browse the repository at this point in the history
- get_mx: filter out implicit MX records
- dep: eslint-plugin-haraka -> @haraka/eslint-config
- chore: lint: remove duplicate / stale rules from .eslintrc
- chore: populate [files] in package.json. Delete .npmignore.
- doc(CONTRIBUTORS): added
- doc(CHANGES): renamed CHANGELOG
- chore: prettier & lint
  • Loading branch information
msimerson authored Apr 18, 2024
1 parent a71ac8d commit 1112fcc
Show file tree
Hide file tree
Showing 19 changed files with 978 additions and 836 deletions.
8 changes: 4 additions & 4 deletions .codeclimate.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
engines:
eslint:
enabled: true
channel: "eslint-8"
channel: 'eslint-8'
config:
config: ".eslintrc.yaml"
config: '.eslintrc.yaml'

ratings:
paths:
- "**.js"
paths:
- '**.js'
22 changes: 2 additions & 20 deletions .eslintrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,6 @@ env:
node: true
es6: true
mocha: true
es2020: true
es2022: true

plugins:
- haraka

extends:
- eslint:recommended
- plugin:haraka/recommended

rules:
indent: [2, 2, {"SwitchCase": 1}]

root: true

globals:
OK: true
CONT: true
DENY: true
DENYSOFT: true
DENYDISCONNECT: true
DENYSOFTDISCONNECT: true
extends: ['@haraka']
6 changes: 4 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Fixes #

Changes proposed in this pull request:
-
-

-
-

Checklist:

- [ ] docs updated
- [ ] tests updated
- [ ] Changes.md updated
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
allow:
- dependency-type: production
9 changes: 4 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
name: CI

on: [ push, pull_request ]
on: [push, pull_request]

env:
CI: true

jobs:

lint:
uses: haraka/.github/.github/workflows/lint.yml@master

Expand All @@ -15,9 +14,9 @@ jobs:
# secrets: inherit

ubuntu:
needs: [ lint ]
needs: [lint]
uses: haraka/.github/.github/workflows/ubuntu.yml@master

windows:
needs: [ lint ]
uses: haraka/.github/.github/workflows/windows.yml@master
needs: [lint]
uses: haraka/.github/.github/workflows/windows.yml@master
6 changes: 3 additions & 3 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: "CodeQL"
name: 'CodeQL'

on:
push:
branches: [ master ]
branches: [master]
pull_request:
branches: [ master ]
branches: [master]
schedule:
- cron: '18 7 * * 4'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ env:
jobs:
publish:
uses: haraka/.github/.github/workflows/publish.yml@master
secrets: inherit
secrets: inherit
58 changes: 0 additions & 58 deletions .npmignore

This file was deleted.

2 changes: 2 additions & 0 deletions .prettierrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
singleQuote: true
semi: false
2 changes: 1 addition & 1 deletion .release
32 changes: 19 additions & 13 deletions Changes.md → CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,53 @@
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/).

### Unreleased

### [1.2.5] - 2024-04-17

- get_mx: filter out implicit MX records
- dep: eslint-plugin-haraka -> @haraka/eslint-config
- chore: lint: remove duplicate / stale rules from .eslintrc
- chore: populate [files] in package.json. Delete .npmignore.
- doc(CONTRIBUTORS): added
- doc(CHANGES): renamed CHANGELOG
- chore: prettier

### [1.2.4] - 2024-02-07

- doc(README): add ini code fences, improve docs
- dep(net-utils): bumped 1.5.0 -> 1.5.3


### [1.2.3] - 2023-07-14

- fix: Handle DNS TXT array result (#15)


### [1.2.2] - 2023-06-22

- fix: check for DNS results befor iterating, fixes #13
- es6(lib/spf): replace `self` with `this`


### [1.2.1] - 2023-06-19

- fix: call skip_hosts via 'this' instead of exports (#11)
- skip configuration was being ignored
- es6(index): replace `plugin` with `this`
- deps: bump versions to latest


### [1.2.0] - 2023-01-19

- Export SPF class (#8)


### [1.1.3] - 2022-12-23

- fix print log (#6)


### [1.1.2] - 2022-12-21

- dep: depend on net-utils 1.5.0
- refactor: convert loop to for...of


### [1.1.0] - 2022-12-17

- spf: use async/await dns
Expand All @@ -52,23 +57,24 @@
- index: safeguard cfg path with optional chaining, fixes #2
- dep(nopt): bump 6 -> 7


### [1.0.1] - 2022-07-23

- add bin/spf
- move spf.js to lib/spf.js


### 1.0.0 - 2022-07-23

- Import from Haraka


[1.0.0]: https://github.com/haraka/haraka-plugin-spf/releases/tag/v1.0.0
[1.0.1]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.0.1
[1.1.2]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.1.2
[1.1.0]: https://github.com/haraka/haraka-plugin-spf/releases/tag/v1.1.0
[1.1.2]: https://github.com/haraka/haraka-plugin-spf/releases/tag/v1.1.2
[1.1.3]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.1.3
[1.1.4]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.1.4
[1.2.0]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.2.0
[1.2.1]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.2.1
[1.3.0]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.3.0
[1.2.2]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.2.2
[1.2.3]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.2.3
[1.2.4]: https://github.com/haraka/haraka-plugin-spf/releases/tag/1.2.4
[1.2.4]: https://github.com/haraka/haraka-plugin-spf/releases/tag/v1.2.4
[1.2.5]: https://github.com/haraka/haraka-plugin-spf/releases/tag/v1.2.5
8 changes: 8 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributors

This handcrafted artisinal software is brought to you by:

| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/haraka-plugin-spf/commits?author=msimerson">13</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/82041?v=4"><br><a href="https://github.com/gramakri">gramakri</a> (<a href="https://github.com/haraka/haraka-plugin-spf/commits?author=gramakri">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/918201?v=4"><br><a href="https://github.com/DoobleD">DoobleD</a> (<a href="https://github.com/haraka/haraka-plugin-spf/commits?author=DoobleD">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/550490?v=4"><br><a href="https://github.com/smfreegard">smfreegard</a> (<a href="https://github.com/haraka/haraka-plugin-spf/commits?author=smfreegard">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/8930018?v=4"><br><a href="https://github.com/ne4t0">ne4t0</a> (<a href="https://github.com/haraka/haraka-plugin-spf/commits?author=ne4t0">1</a>) |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

<sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ domain whilst preserving the original return-path.

## Configuration

-------------
---

This plugin uses spf.ini for configuration and the following options are
available:


```ini
[relay]
context=sender (default: sender)
Expand Down Expand Up @@ -64,27 +63,27 @@ openspf_text = true

### Things to Know

* Most senders do not publish SPF records for their mail server *hostname*,
- Most senders do not publish SPF records for their mail server _hostname_,
which means that the SPF HELO test rarely passes. During observation in 2014,
more spam senders have valid SPF HELO than ham senders. If you expect very
little from SPF HELO validation, you might still be disappointed.

* Enabling error deferrals will cause excessive delays and perhaps bounced
- Enabling error deferrals will cause excessive delays and perhaps bounced
mail for senders with broken DNS. Enable this only if you are willing to
delay and sometimes lose valid mail.

* Broken SPF records by valid senders are common. Keep that in mind when
- Broken SPF records by valid senders are common. Keep that in mind when
considering denial of SPF error results. If you deny on error, budget
time for instructing senders on how to correct their SPF records so they
can email you.

* The only deny option most sites should consider is `mfrom_fail`. That will
- The only deny option most sites should consider is `mfrom_fail`. That will
reject messages that explicitely fail SPF tests. SPF failures have a high
correlation with spam. However, up to 10% of ham transits forwarders and/or
email lists which frequently break SPF. SPF results are best used as inputs
to other plugins such as DMARC, [spamassassin](http://haraka.github.io/manual/plugins/spamassassin.html), and [karma](http://haraka.github.io/manual/plugins/karma.html).

* Heed well the implications of SPF, as described in [RFC 4408](http://tools.ietf.org/html/rfc4408#section-9.3)
- Heed well the implications of SPF, as described in [RFC 4408](http://tools.ietf.org/html/rfc4408#section-9.3)

### spf.ini default settings

Expand Down Expand Up @@ -140,9 +139,7 @@ mfrom_permerror=false
openspf_text=false
```


Testing
-------
## Testing

This plugin also provides a command-line test tool that can be used to debug SPF issues or to check results.

Expand All @@ -167,8 +164,8 @@ You can add `--debug` to the option arguments to see a full trace of the SPF pro
Node does not support the SPF DNS Resource Record type. Only TXT records are
checked. This is a non-issue as < 1% (as of 2014) of SPF records use the SPF RR type. Due to lack of adoption, SPF has deprecated the SPF RR type.


<!-- leave these buried at the bottom of the document -->

[ci-img]: https://github.com/haraka/haraka-plugin-spf/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/haraka/haraka-plugin-spf/actions/workflows/ci.yml
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-spf/badges/gpa.svg
Expand Down
Loading

0 comments on commit 1112fcc

Please sign in to comment.