=============
vmod_hoailona
=============

----------------------------------------
Akamai SecureHD Token Authorization VMOD
----------------------------------------

**THIS BRANCH IS FOR VARNISH-CACHE MASTER trunk >7.3 ONLY**

See branches for support of older versions.

.. role:: ref(emphasis)

.. _Varnish-Cache: https://varnish-cache.org/

DESCRIPTION
===========

This Varnish Module (VMOD) supports use of the SecureHD Policy service
provided by Akamai Media Services. Applications of the VMOD include:

* Defining policies for access to media content:

  * Policy type TOKEN: token authorization required, with a TTL
    (time-to-live) limiting the duration of authorized access, and
    possibly with a shared secret used for keyed-hash message
    authentication codes (HMACs) that are required for authorization

  * Policy type OPEN: access permitted without authorization

  * Policy type DENY: access denied

* Assigning policies to hosts, either globally for a host, or for
  sets of paths defined for the host

* Determining which policy holds for a given host and path

* Generating authorization tokens

This manual presupposes familiarity with the Akamai SecureHD
service. For more information, see the documentation provided by
Akamai (see `Akamai documentation`_).

The VMOD does not provide cryptographic code to generate HMACs, but it
does provide the means to associate shared secrets with a policy,
which can be used together with a VMOD that does compute HMACs (such
as the ``blobdigest`` VMOD, see `SEE ALSO`_).

The name of the VMOD is inspired by the Hawaiian word *ho`ailona*, for
"sign" or "symbol" (pronounced "ho-eye-lona"), which we believe to be
a suitable translation for "token". We welcome feedback from speakers
of Hawaiian about the choice of the name.

INSTALLATION
============

See `INSTALL.rst <INSTALL.rst>`_ in the source repository.

ACKNOWLEDGEMENTS
================

Development of this module was sponsored by BILD GmbH & Co. KG

SUPPORT
=======

.. _gitlab.com issues: https://gitlab.com/uplex/varnish/libvmod-hoailona/-/issues

To report bugs, use `gitlab.com issues`_.

For enquiries about professional service and support, please contact
info@uplex.de\ .

CONTRIBUTING
============

.. _merge requests on gitlab.com: https://gitlab.com/uplex/varnish/libvmod-hoailona/-/merge_requests

To contribute to the project, please use `merge requests on gitlab.com`_.

To support the project's development and maintenance, there are
several options:

.. _paypal: https://www.paypal.com/donate/?hosted_button_id=BTA6YE2H5VSXA

.. _github sponsor: https://github.com/sponsors/nigoroll

* Donate money through `paypal`_. If you wish to receive a commercial
  invoice, please add your details (address, email, any requirements
  on the invoice text) to the message sent with your donation.

* Become a `github sponsor`_.

* Contact info@uplex.de to receive a commercial invoice for SWIFT payment.

SEE ALSO
========

* varnishd(1)
* vcl(7)
* source repository: https://code.uplex.de/uplex-varnish/libvmod-hoailona
* VMOD blobdigest: https://code.uplex.de/uplex-varnish/libvmod-blobdigest

PROJECT RESOURCES
=================

* The primary repository is at https://code.uplex.de/uplex-varnish/libvmod-hoailona

  This server does not accept user registrations, so please use ...

* the mirror at https://gitlab.com/uplex/varnish/libvmod-hoailona for issues,
  merge requests and all other interactions.

COPYRIGHT
=========

::

  This document is licensed under the same conditions
  as the libvmod-hoailona project. See LICENSE for details.
 
  Author: Geoffrey Simmons <geoffrey.simmons@uplex.de>