1/*  Part of SWI-Prolog
   2
   3    Author:        Jan Wielemaker
   4    E-mail:        J.Wielemaker@vu.nl
   5    WWW:           http://www.swi-prolog.org
   6    Copyright (c)  2015-2016, VU University Amsterdam
   7    All rights reserved.
   8
   9    Redistribution and use in source and binary forms, with or without
  10    modification, are permitted provided that the following conditions
  11    are met:
  12
  13    1. Redistributions of source code must retain the above copyright
  14       notice, this list of conditions and the following disclaimer.
  15
  16    2. Redistributions in binary form must reproduce the above copyright
  17       notice, this list of conditions and the following disclaimer in
  18       the documentation and/or other materials provided with the
  19       distribution.
  20
  21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32    POSSIBILITY OF SUCH DAMAGE.
  33*/
  34
  35:- module(md5,
  36          [ md5_hash/3                  % +Input, -Hash, +Options
  37          ]).
  38
  39:- use_foreign_library(foreign(md54pl)).
  40
  41/** <module> MD5 hashes
  42
  43Compute MD5 hashes  from  a  Prolog   string.  This  library  provides a
  44lightweight alternative to the general secure hash interface provided by
  45library(crypto) from the `ssl` package.
  46
  47@see library(sha), library(hash_stream) and library(crypto).
  48*/
  49
  50%!  md5_hash(+Data, -Hash, +Options) is det.
  51%
  52%   Hash is the MD5 hash of Data,   The  conversion is controlled by
  53%   Options:
  54%
  55%     * encoding(+Encoding)
  56%     If Data is a sequence of character _codes_, this must be
  57%     translated into a sequence of _bytes_, because that is what
  58%     the hashing requires.  The default encoding is =utf8=.  The
  59%     other meaningful value is =octet=, claiming that Data contains
  60%     raw bytes.
  61%
  62%   @arg Data is either an atom, string, code-list or char-list.
  63%   @arg Hash is an atom holding 32 characters, representing the
  64%   hash in hexadecimal notation
  65
  66:- multifile sandbox:safe_primitive/1.
  67
  68sandbox:safe_primitive(md5:md5_hash(_,_,_)).