{"id":18868247,"url":"https://github.com/letsencrypt/spf-flattener","last_synced_at":"2025-09-08T16:37:21.232Z","repository":{"id":239659877,"uuid":"747409411","full_name":"letsencrypt/spf-flattener","owner":"letsencrypt","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-25T01:43:02.000Z","size":67,"stargazers_count":12,"open_issues_count":5,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-28T03:51:12.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/letsencrypt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-23T21:42:03.000Z","updated_at":"2025-03-27T14:32:49.000Z","dependencies_parsed_at":"2024-06-19T05:13:52.032Z","dependency_job_id":"13190eba-5880-45ff-9fad-348c86bcbbdf","html_url":"https://github.com/letsencrypt/spf-flattener","commit_stats":null,"previous_names":["letsencrypt/spf-flattener"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letsencrypt%2Fspf-flattener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letsencrypt%2Fspf-flattener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letsencrypt%2Fspf-flattener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letsencrypt%2Fspf-flattener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/letsencrypt","download_url":"https://codeload.github.com/letsencrypt/spf-flattener/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248897215,"owners_count":21179557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T05:13:14.862Z","updated_at":"2025-04-14T14:31:47.176Z","avatar_url":"https://github.com/letsencrypt.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SPF-FLATTENER\n\nThis tool flattens the SPF record for a given domain to avoid reaching the 10 DNS lookup cap.\n\n## Flags\n| Flag | Required? | Type | Default | Description |\n|------| ----------| --------| -----|-------------|\n| domain | *required* | string | | root domain to set SPF record for |\n| initialSPF | *optional* | string | \"\" | initial SPF record to flatten* |\n| verbose | *optional* | bool | false | if true, print extra debug lines |\n| dryrun | *optional* | bool | true | if false, update existing SPF record with flattened SPF |\n| warn | *optional* | bool | true | if true, compares initial and flattened SPF, warning when different |\n| url | *optional*** | string | \"\" | url to PATCH updated SPF record |\n| authEmail | *optional*** | string | \"\" | X-Auth-Email header value |\n| authKey | *optiona*** | string | \"\" | X-Auth-Key header value |\n\n*if not provided, will lookup and use existing SPF record for domain\n\n**unless dryrun is false, then required\n\n## Example use cases\n\n**Base case**: one-time flatten tool, just want to output flattened record:\n```\ngo run main.go --domain \u003cdomain\u003e --warn false\n```\n\n**Dynamic update case**: update SPF tool that acts without intervention. For example, a cron job that runs:\n```\ngo run main.go --domain \u003cdomain\u003e --initialSPF \"\u003cspfRecord\u003e\" --dryrun false --warn false --url \"\u003curl\u003e\" --authEmail \"\u003cemail\u003e\" --authKey \"\u003ckey\u003e\"\n```\n\n**Dynamic warning case**: recurring check SPF tool that alerts/warns on change. For example, a cron job that runs:\n```\ngo run main.go --domain \u003cdomain\u003e --intialSPF=\"\u003cspfRecord\u003e\" \n```\nThen once someone checks/approves of change, run once:\n```\ngo run main.go --domain \u003cdomain\u003e --initialSPF \"\u003cspfRecord\u003e\" --dryrun false --warn false --url \"\u003curl\u003e\" --authEmail \"\u003cemail\u003e\" --authKey \"\u003ckey\u003e\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fletsencrypt%2Fspf-flattener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fletsencrypt%2Fspf-flattener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fletsencrypt%2Fspf-flattener/lists"}