1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# lua-psl
Bindings to [libpsl](https://github.com/rockdaboot/libpsl), a C library that handles the Public Suffix List (PSL).
The PSL is a list of domains where there may be sub-domains outside of the administrator's control.
e.g. the administrator of '.com' does not manage 'github.com'.
This list has found use in many internet technologies including:
- preventing cross-domain cookie leakage
- allowance of issuing wildcard TLS certificates
More information can be found at [publicsuffix.org](https://publicsuffix.org/)
## Documentation
Can be found at [https://daurnimator.github.io/lua-psl/](https://daurnimator.github.io/lua-psl/)
## Features
- Compatible with Lua 5.1, 5.2, 5.3 and [LuaJIT](http://luajit.org/)
## Status
- This project was started in late 2016
- Binds all functions available from libpsl up to the 0.19 release
# Installation
It's recommended to install lua-psl by using [luarocks](https://luarocks.org/).
$ luarocks install psl
## Dependencies
- [libpsl](https://github.com/rockdaboot/libpsl) >= 0.4.0
### For running tests
- [busted](http://olivinelabs.com/busted/)
# Development
## Getting started
- Clone the repo:
```
$ git clone https://github.com/daurnimator/lua-psl.git
$ cd lua-psl
```
- Install your local copy:
```
$ luarocks make psl-scm-0.rockspec
```
- Run tests ([install tools first](#for-running-tests))
```
$ busted
```
## Generating documentation
Documentation is written in markdown and intended to be consumed by [pandoc](http://pandoc.org/). See the `doc/` directory for more information.
|
