C library for the Public Suffix List
Go to file
Tim Rühsen 8d9e490ee7
Merge pull request #151 from nirbheek/fix-buildtype-usage
meson: Use the b_vscrt option for selecting the CRT
2020-04-03 15:22:51 +02:00
.github Add Github FUNDING.yml 2020-03-07 20:42:04 +01:00
contrib Add contrib/spell-checker 2018-12-28 19:45:30 +01:00
docs/libpsl gtk-doc: do not include tree_index.sgml 2019-06-01 13:13:50 +02:00
fuzz Fix build when dirent.h is not available 2019-06-05 09:45:50 +02:00
include Fix patch version in include/meson.build 2019-04-17 12:33:03 +02:00
list@826d762a07 Update PSL data from upstream 2019-04-05 15:04:57 +02:00
m4 Add m4/ax_check_compile_flag.m4 2017-07-27 11:55:29 +02:00
msvc NMake builds: Make PDB generation cleaner 2019-10-30 18:09:00 +08:00
po autoconf first version 2014-03-20 22:43:04 +01:00
src meson: run python script against the meson version of python 2020-04-02 15:16:20 +11:00
tests meson: run python script against the meson version of python 2020-04-02 15:16:20 +11:00
tools Include meson build files into tarball 2019-04-17 12:05:00 +02:00
.dir-locals.el document indentation conventions for emacs users 2014-03-21 14:39:17 -04:00
.gitignore Rename suffixes_dafsa.c to suffixes_dafsa.h 2018-12-06 09:11:02 -05:00
.gitmodules Add https://github.com/publicsuffix as git submodule 2015-07-14 13:25:42 +02:00
.lgtm.yml Add .lgtm.yml 2018-10-15 17:29:23 +02:00
.travis.yml Add building of an lzip tarball archive 2019-04-16 14:42:34 +02:00
.travis_coveralls.sh Cleanup .travis_coveralls.sh 2017-07-27 11:07:00 +02:00
AUTHORS Release V0.21.0 2019-04-16 15:10:17 +02:00
COPYING Update copyrights 2018-02-22 10:04:00 +01:00
LICENSE Update copyright years 2015-09-23 14:50:01 +02:00
Makefile.am Include meson build files into tarball 2019-04-17 12:05:00 +02:00
NEWS Release V0.21.0 2019-04-16 15:10:17 +02:00
README inital commit 2014-03-20 17:17:24 +01:00
README.MSVC.md NMake builds: Include Visual Studio version in output dir 2019-10-30 18:07:19 +08:00
README.md Add instructions on building with MSVC 2019-10-30 17:36:06 +08:00
autogen.sh Let autogen.sh work on Solaris and without gtkdocize 2016-01-02 13:01:19 +01:00
configure.ac psl.c: Include strings.h only if it is available 2020-03-10 15:16:25 +01:00
libpsl.pc.in s/Publix/Public/ 2016-12-07 16:14:04 +08:00
meson.build meson: Use the b_vscrt option for selecting the CRT 2020-04-03 16:45:11 +05:30
meson.build.in Add recent changes from meson.build to meson.build.in 2020-03-10 15:47:55 +01:00
meson_options.txt Add initial Meson build system 2018-12-07 09:54:20 -05:00

README.md

Travis-CI Status Coverity Scan Coverage Status

Solaris OpenCSW Build Status Solaris amd64 Build Status Solaris i386 Build Status Solaris Sparc Build Status Solaris SparcV9

libpsl - C library to handle the Public Suffix List

A Public Suffix List is a collection of Top Level Domains (TLDs) suffixes. TLDs include Global Top Level Domains (gTLDs) like .com and .net; Country Top Level Domains (ccTLDs) like .de and .cn; and Brand Top Level Domains like .apple and .google. Brand TLDs allows users to register their own top level domain that exist at the same level as ICANN's gTLDs. Brand TLDs are sometimes referred to as Vanity Domains.

Browsers, web clients and other user agents can use a public suffix list to:

  • avoid privacy-leaking "supercookies"
  • avoid privacy-leaking "super domain" certificates (see post from Jeffry Walton)
  • domain highlighting parts of the domain in a user interface
  • sorting domain lists by site

Libpsl...

  • has built-in PSL data for fast access (DAWG/DAFSA reduces size from 180kB to ~32kB)
  • allows to load PSL data from files
  • checks if a given domain is a "public suffix"
  • provides immediate cookie domain verification
  • finds the longest public part of a given domain
  • finds the shortest private part of a given domain
  • works with international domains (UTF-8 and IDNA2008 Punycode)
  • is thread-safe
  • handles IDNA2008 UTS#46 (if libicu is available)

Find more information about the Public Suffix List here.

Download the Public Suffix List here.

The original DAFSA code is from the Chromium Project.

API Documentation

You find the current API documentation here.

Quick API example

#include <stdio.h>
#include <libpsl.h>

int main(int argc, char **argv)
{
	const char *domain = "www.example.com";
	const char *cookie_domain = ".com";
	const psl_ctx_t *psl = psl_builtin();
	int is_public, is_acceptable;

	is_public = psl_is_public_suffix(psl, domain);
	printf("%s %s a public suffix.\n", domain, is_public ? "is" : "is not");

	is_acceptable = psl_is_cookie_domain_acceptable(psl, domain, cookie_domain);
	printf("cookie domain '%s' %s acceptable for domain '%s'.\n",
		cookie_domain, is_acceptable ? "is" : "is not", domain);

	return 0;
}

Command Line Tool

Libpsl comes with a tool 'psl' that gives you access to most of the library API via command line.

$ psl --help

prints the usage.

Convert PSL into DAFSA

The DAFSA format is a compressed representation of strings. Here we use it to reduce the whole PSL to about 32k in size.

Generate psl.dafsa from list/public_suffix_list.dat

$ src/psl-make-dafsa --output-format=binary list/public_suffix_list.dat psl.dafsa

Test the result (example)

$ tools/psl --load-psl-file psl.dafsa aeroclub.aero

License

Libpsl is made available under the terms of the MIT license.
See the LICENSE file that accompanies this distribution for the full text of the license.

src/psl-make-dafsa and src/lookup_string_in_fixed_set.c are licensed under the term written in src/LICENSE.chromium.

Building from git

You should have python2.7+ installed.

Download project and prepare sources with

	git clone https://github.com/rockdaboot/libpsl
	./autogen.sh
	./configure
	make
	make check

If you prefer a meson build

	meson builddir
	ninja -C builddir
	ninja -C builddir test

There is also an unofficial MSVC nmake build configuration in msvc/. Please see README.MSVC.md on building libpsl with Visual Studio via NMake or Meson.

Mailing List

Mailing List Archive

Mailing List

To join the mailing list send an email to

libpsl-bugs+subscribe@googlegroups.com

and follow the instructions provided by the answer mail.

Or click join.