The oe-encode Reference Manual

Table of Contents

The oe-encode Reference Manual

This is the oe-encode Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:00:04 2021 GMT+0.

1 Introduction

* Introduction
  This is a port of Pieter van Ginkel's C# [[https://github.com/pvginkel/ProgressEncode][implementation]] of the
  =ENCODE()= hash function from Progress OpenEdge. To paraphrase
  Pieter: Progress has declined to make the algorithm for =ENCODE()=
  public, which is problematic when working with legacy systems
  (particularly where it's been used to hash user passwords). This
  implementation provides a compatible implementation of the hash
  function.

* API
** (hash-bytes bytes)
   Usage:
   : (hash-bytes #(1 2 3 4))
   : ;=> #(97 98 109 99 97 110 106 67 108 106 102 120 113 77 76 119)

   =HASH-BYTES= takes a sequence of =(unsigned-byte 8)= and returns a
   =(vector (unsigned-byte 8) 16)= that is the bytes of the resulting
   hash.

** (hash-string string &key encoding)
   Usage:
   : (hash-string "foo" :encoding :utf-8)
   : ;=> #(108 97 99 100 107 71 106 117 108 105 106 99 108 110 97 97)

   =HASH-STRING= uses =HASH-BYTES= to hash the input string after
   encoding it with the specified encoding. If =:encoding= is not
   supplied, =:iso-8559-1= is used.

** (hash-string->string string &key in-encoding out-encoding)
   Usage:
   : (oe-encode:hash-string->string "foo" :in-encoding :utf-8 :out-encoding :utf-8)
   : ;=> "lacdkGjulijclnaa"

   =HASH-STRING->STRING= works like =HASH-STRING= but decodes the
   result result into a string before returning it -- the Progress API
   operates on and returns strings, so this is likely to be the most
   convenient function for working with existing data. =:in-encoding=
   is used to encode the input before hashing and defaults to
   =:iso-8559-1=, =:out-encoding= is used to decode the resulting hash
   bytes as a string and defaults to the value of =:in-encoding=.

   Note that the =ENCODE()= algorithm ensures that output bytes are
   always in the range of alphabetic ASCII characters, so output
   encodings that are ASCII-compatible are preferrable.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 oe-encode

Author

Matthew Stickney <mtstickney@gmail.com>

License

CC0 1.0 Public Domain

Description

An implementation of the ENCODE() hash function from Progress OpenEdge.

Dependency

babel

Source

oe-encode.asd (file)

Component

encode.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 oe-encode.asd

Location

oe-encode.asd

Systems

oe-encode (system)

3.1.2 oe-encode/encode.lisp

Parent

oe-encode (system)

Location

encode.lisp

Packages

oe-encode

Exported Definitions

• hash-bytes (function)
• hash-string (function)
• hash-string->string (function)

Internal Definitions

+magic-numbers+ (special variable)

4 Packages

Packages are listed by definition order.

4.1 oe-encode

Source

encode.lisp (file)

Use List

common-lisp

Exported Definitions

• hash-bytes (function)
• hash-string (function)
• hash-string->string (function)

Internal Definitions

+magic-numbers+ (special variable)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: hash-bytes BYTES

Package

oe-encode

Source

encode.lisp (file)

Function: hash-string STRING &key ENCODING

Package

oe-encode

Source

encode.lisp (file)

Function: hash-string->string STRING &key IN-ENCODING OUT-ENCODING

Package

oe-encode

Source

encode.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: +magic-numbers+

Package

oe-encode

Source

encode.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types