C library for the Public Suffix List
Go to file
Tim Rühsen 74f715bd9c started with libidn2 integration 2014-06-27 17:13:30 +02:00
data updated PSL data 2014-06-18 16:48:15 +02:00
docs/libpsl added docs for psl_error_t 2014-06-20 17:12:17 +02:00
include fixed psl_str_to_utf8lower prototype 2014-06-23 12:50:02 +02:00
po autoconf first version 2014-03-20 22:43:04 +01:00
src started with libidn2 integration 2014-06-27 17:13:30 +02:00
tests started with libidn2 integration 2014-06-27 17:13:30 +02:00
tools introduced defines for error codes 2014-06-20 12:36:51 +02:00
.dir-locals.el document indentation conventions for emacs users 2014-03-21 14:39:17 -04:00
.gitignore git should ignore ephemeral files. 2014-03-21 14:19:25 -04:00
.travis.yml adjusted .travis.yml 2014-06-19 15:26:00 +02:00
ABOUT-NLS autoconf first version 2014-03-20 22:43:04 +01:00
AUTHORS Release V0.4.0 2014-06-23 12:12:54 +02:00
COPYING fixed authors name to UTF-8 2014-06-27 09:54:32 +02:00
LICENSE fixed authors name to UTF-8 2014-06-27 09:54:32 +02:00
Makefile.am remove LIBPSL_API_VERSION for simplicity 2014-05-31 18:56:07 +02:00
NEWS fixed authors name to UTF-8 2014-06-27 09:54:32 +02:00
README inital commit 2014-03-20 17:17:24 +01:00
README.md Release V0.3.0 2014-06-05 16:29:20 +02:00
autogen.sh removed check for idn2 from autogen.sh 2014-06-06 14:15:40 +02:00
configure.ac started with libidn2 integration 2014-06-27 17:13:30 +02:00
libpsl.pc.in remove LIBPSL_API_VERSION for simplicity 2014-05-31 18:56:07 +02:00

README.md

Build Status

libpsl - C library to handle the Public Suffix List

A "public suffix" is a domain name under which Internet users can directly register own names.

Browsers and other web clients can use it 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
  • 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 (libicu is used by psl2c if installed)

Find more information about the Publix Suffix List here.

Download the Public Suffix List here.

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.

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.

Building from git

Download project and prepare sources with

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

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.