https://github.com/daurnimator/lua-psl

Lua bindings to libpsl (https://github.com/rockdaboot/libpsl)
https://github.com/daurnimator/lua-psl

libpsl lua lua-bindings psl public-suffix-list

Last synced: 2 months ago
JSON representation

Lua bindings to libpsl (https://github.com/rockdaboot/libpsl)

• Host: GitHub
• URL: https://github.com/daurnimator/lua-psl
• Owner: daurnimator
• License: mit
• Created: 2016-11-10T02:33:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-26T13:48:11.000Z (about 4 years ago)
• Last Synced: 2024-10-05T14:50:35.262Z (3 months ago)
• Topics: libpsl, lua, lua-bindings, psl, public-suffix-list
• Language: C
• Size: 104 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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, 5.4 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.