Top |
psl_ctx_t * | psl_load_file () |
psl_ctx_t * | psl_load_fp () |
psl_ctx_t * | psl_latest () |
const psl_ctx_t * | psl_builtin () |
void | psl_free () |
int | psl_is_public_suffix () |
int | psl_is_public_suffix2 () |
const char * | psl_unregistrable_domain () |
const char * | psl_registrable_domain () |
int | psl_suffix_count () |
int | psl_suffix_exception_count () |
int | psl_suffix_wildcard_count () |
time_t | psl_builtin_file_time () |
const char * | psl_builtin_sha1sum () |
const char * | psl_builtin_filename () |
int | psl_builtin_outdated () |
int | psl_is_cookie_domain_acceptable () |
const char * | psl_dist_filename () |
const char * | psl_get_version () |
int | psl_check_version_number () |
psl_error_t | psl_str_to_utf8lower () |
void | psl_free_string () |
#define | PSL_API |
#define | PSL_VERSION |
#define | PSL_VERSION_MAJOR |
#define | PSL_VERSION_MINOR |
#define | PSL_VERSION_NUMBER |
#define | PSL_VERSION_PATCH |
#define | PSL_TYPE_ICANN |
#define | PSL_TYPE_PRIVATE |
#define | PSL_TYPE_NO_STAR_RULE |
#define | PSL_TYPE_ANY |
enum | psl_error_t |
typedef | psl_ctx_t |
psl_ctx_t *
psl_load_file (const char *fname
);
This function loads the public suffixes file named fname
.
To free the allocated resources, call psl_free()
.
The suffixes are expected to be UTF-8 encoded (lowercase + NFKC) if they are international.
Since: 0.1
psl_ctx_t *
psl_load_fp (FILE *fp
);
This function loads the public suffixes from a FILE
pointer.
To free the allocated resources, call psl_free()
.
The suffixes are expected to be UTF-8 encoded (lowercase + NFKC) if they are international.
Since: 0.1
psl_ctx_t *
psl_latest (const char *fname
);
This function loads the the latest available PSL data from either
fname
(application specific filename, may be NULL
)
location specified during built-time (filename from ./configure --with-psl-distfile)
built-in PSL data (generated from ./configure --with-psl-file)
location of built-in data (filename from ./configure --with-psl-file)
If none of the above is available, the function returns NULL
.
To free the allocated resources, call psl_free()
.
Since: 0.16
const psl_ctx_t *
psl_builtin (void
);
This function returns the PSL context that has been generated and built in at compile-time. You don't have to free the returned context explicitly.
The builtin data also contains punycode entries, one for each international domain name.
If the generation of built-in data has been disabled during compilation, NULL
will be returned.
When using the builtin psl context, you can provide UTF-8 (lowercase + NFKC) or ASCII/ACE (punycode)
representations of domains to functions like psl_is_public_suffix()
.
Since: 0.1
void
psl_free (psl_ctx_t *psl
);
This function frees the the PSL context that has been retrieved via
psl_load_fp()
or psl_load_file()
.
Since: 0.1
int psl_is_public_suffix (const psl_ctx_t *psl
,const char *domain
);
This function checks if domain
is a public suffix by the means of the
Mozilla Public Suffix List.
For cookie domain checking see psl_is_cookie_domain_acceptable()
.
International domain
names have to be either in UTF-8 (lowercase + NFKC) or in ASCII/ACE format (punycode).
Other encodings likely result in incorrect return values.
Use helper function psl_str_to_utf8lower()
for normalization domain
.
psl
is a context returned by either psl_load_file()
, psl_load_fp()
or
psl_builtin()
.
Since: 0.1
int psl_is_public_suffix2 (const psl_ctx_t *psl
,const char *domain
,int type
);
This function checks if domain
is a public suffix by the means of the
Mozilla Public Suffix List.
type
specifies the PSL section where to perform the lookup. Valid values are
PSL_TYPE_PRIVATE
, PSL_TYPE_ICANN
, PSL_TYPE_NO_STAR_RULE
, and PSL_TYPE_ANY
.
PSL_TYPE_NO_STAR_RULE
switches of the 'prevailing star rule' (see
List under 'Algorithm' 2.).
Applying the flag means that TLDs not explicitly listed in the PSL are *not* treated as public suffixes.
International domain
names have to be either in UTF-8 (lowercase + NFKC) or in ASCII/ACE format (punycode).
Other encodings likely result in incorrect return values.
Use helper function psl_str_to_utf8lower()
for normalization domain
.
psl
is a context returned by either psl_load_file()
, psl_load_fp()
or
psl_builtin()
.
Since: 0.1
const char * psl_unregistrable_domain (const psl_ctx_t *psl
,const char *domain
);
This function finds the longest public suffix part of domain
by the means
of the Mozilla Public Suffix List.
International domain
names have to be either in UTF-8 (lowercase + NFKC) or in ASCII/ACE format (punycode).
Other encodings likely result in incorrect return values.
Use helper function psl_str_to_utf8lower()
for normalization domain
.
psl
is a context returned by either psl_load_file()
, psl_load_fp()
or
psl_builtin()
.
Pointer to longest public suffix part of domain
or NULL
if domain
does not contain a public suffix (or if psl
is NULL
).
Since: 0.1
const char * psl_registrable_domain (const psl_ctx_t *psl
,const char *domain
);
This function finds the shortest private suffix part of domain
by the means
of the Mozilla Public Suffix List.
International domain
names have to be either in UTF-8 (lowercase + NFKC) or in ASCII/ACE format (punycode).
Other encodings likely result in incorrect return values.
Use helper function psl_str_to_utf8lower()
for normalization domain
.
psl
is a context returned by either psl_load_file()
, psl_load_fp()
or
psl_builtin()
.
Pointer to shortest private suffix part of domain
or NULL
if domain
does not contain a private suffix (or if psl
is NULL
).
Since: 0.1
int
psl_suffix_count (const psl_ctx_t *psl
);
This function returns number of public suffixes maintained by psl
.
The number of exceptions within the Public Suffix List are not included.
If the information is not available, the return value is -1 (since 0.19).
This is the case with DAFSA blobs or if psl
is NULL
.
Number of public suffixes entries in PSL context or -1 if this information is not available.
Since: 0.1
int
psl_suffix_exception_count (const psl_ctx_t *psl
);
This function returns number of public suffix exceptions maintained by psl
.
If the information is not available, the return value is -1 (since 0.19).
This is the case with DAFSA blobs or if psl
is NULL
.
Number of public suffix exceptions in PSL context or -1 if this information is not available.
Since: 0.1
int
psl_suffix_wildcard_count (const psl_ctx_t *psl
);
This function returns number of public suffix wildcards maintained by psl
.
If the information is not available, the return value is -1 (since 0.19).
This is the case with DAFSA blobs or if psl
is NULL
.
Number of public suffix wildcards in PSL context or -1 if this information is not available.
Since: 0.10.0
time_t
psl_builtin_file_time (void
);
This function returns the mtime of the Public Suffix List file that has been built in.
If the generation of built-in data has been disabled during compilation, 0 will be returned.
Since: 0.1
const char *
psl_builtin_sha1sum (void
);
This function returns the SHA1 checksum of the Public Suffix List file that has been built in. The returned string is in lowercase hex encoding, e.g. "2af1e9e3044eda0678bb05949d7cca2f769901d8".
If the generation of built-in data has been disabled during compilation, an empty string will be returned.
Since: 0.1
const char *
psl_builtin_filename (void
);
This function returns the file name of the Public Suffix List file that has been built in.
If the generation of built-in data has been disabled during compilation, an empty string will be returned.
Since: 0.1
int
psl_builtin_outdated (void
);
This function checks if the built-in data is older than the file it has been created from. If it is, it might be a good idea for the application to reload the PSL. The mtime is taken as reference.
If the PSL file does not exist, it is assumed that the built-in data is not outdated.
Since: 0.10.0
int psl_is_cookie_domain_acceptable (const psl_ctx_t *psl
,const char *hostname
,const char *cookie_domain
);
This helper function checks whether cookie_domain
is an acceptable cookie domain value for the request
hostname
.
For international domain names both, hostname
and cookie_domain
, have to be either in UTF-8 (lowercase + NFKC)
or in ASCII/ACE (punycode) format. Other encodings or mixing UTF-8 and punycode likely result in incorrect return values.
Use helper function psl_str_to_utf8lower()
for normalization of hostname
and cookie_domain
.
Examples:
Cookie domain 'example.com' would be acceptable for hostname 'www.example.com', but '.com' or 'com' would NOT be acceptable since 'com' is a public suffix.
Cookie domain 'his.name' would be acceptable for hostname 'remember.his.name', but NOT for 'forgot.his.name' since 'forgot.his.name' is a public suffix.
psl |
PSL context pointer |
|
hostname |
The request hostname. |
|
cookie_domain |
The domain value from a cookie |
Since: 0.1
const char *
psl_dist_filename (void
);
This function returns the file name of the distribution/system PSL data file.
This file will be considered by psl_latest()
.
Return the filename that is set by ./configure --with-psl-distfile, or an empty string.
Since: 0.16
int
psl_check_version_number (int version
);
Check the given version number is at minimum the current library version number. The version number must be a hexadecimal number like 0x000a01 (V0.10.1).
Returns the library version number if the given version number is at least the version of the library, else return 0; If the argument is 0, the function returns the library version number without performing a check.
Since: 0.11.0
psl_error_t psl_str_to_utf8lower (const char *str
,const char *encoding
,const char *locale
,char **lower
);
This helper function converts a string to UTF-8 lowercase + NFKC representation. Lowercase + NFKC UTF-8 is needed as input to the domain checking functions.
lower
stays unchanged on error.
When returning PSL_SUCCESS, the return value 'lower' must be freed after usage.
psl_error_t value.
PSL_SUCCESS: Success
PSL_ERR_INVALID_ARG: str
is a NULL
value.
PSL_ERR_CONVERTER: Failed to open the unicode converter with name encoding
PSL_ERR_TO_UTF16: Failed to convert str
to unicode
PSL_ERR_TO_LOWER: Failed to convert unicode to lowercase
PSL_ERR_TO_UTF8: Failed to convert unicode to UTF-8
PSL_ERR_NO_MEM: Failed to allocate memory
Since: 0.4
void
psl_free_string (char *str
);
This function free()
's the memory allocated by psl_str_to_utf8lower()
when
returning a lowercase string
Since: 0.19
Return codes for PSL functions. Negative return codes mean failure. Positive values are reserved for non-error return codes.