Update NEWS for 2.0.5 release

Fix SBCL byte copy for newer SBCL interface #3

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Common Lisp CI
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    name: ${{ matrix.lisp }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        lisp: [sbcl-bin, clisp]
+        os: [ubuntu-latest, macOS-latest]
+        exclude:
+          # CLISP currently does not build on ubuntu due to readline7
+          - lisp: clisp
+            os: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Roswell
+        env:
+          LISP: ${{ matrix.lisp }}
+        run: |
+          curl -L https://raw.githubusercontent.com/roswell/roswell/master/scripts/install-for-ci.sh | sh
+
+      - name: Build and Run Tests
+        run: |
+          ros -e '(pushnew :md5-testing cl:*features*)
+           (ql:quickload "md5")
+           (unless (md5::test-rfc1321)
+             (uiop:quit 1))
+           (unless (md5::test-other)
+             (uiop:quit 1))'

COPYING

@@ -3,3 +3,128 @@ This software has been placed into the public domain.
 This software is "as is", and has no warranty of any kind.  The
 authors assume no responsibility for the consequences of any use of
 this software.
+
+Additionally for all parts of this software ("The Work" below) authored
+by Pierre R. Mai copyright is waived under the CC0 as affirmed below:
+
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

NEWS

@@ -1,3 +1,34 @@
+Release 2.0.5
+=============
+
+ * Fix SBCL-specific sequence copying implementation to use better
+   suited internal interface.
+
+Release 2.0.4
+=============
+
+ * Clarified public domain status for code authored by Pierre R. Mai
+   through additional CC0 waiver.
+
+Release 2.0.3
+=============
+
+ * Add support for md5sum-string for other implementations through
+   through flexi-streams.  Patch supplied by Daniel Kochmanski.
+
+
+Release 2.0.2
+=============
+
+ * This release adds support for LispWorks 7.0, reworking the fixes
+   for 64-bit implementations of Lispworks in 2.0.1 and incorrect
+   use of the sys:simple-int32-vector type.  Patch supplied by
+   Martin Simmons from LispWorks.
+
+ * Minor fix to prevent style-warnings for implementations with no
+   support for md5sum-string.
+
+
 Release 2.0.1
 =============
 

README.md

@@ -1,5 +1,7 @@
+[![Build Status](https://github.com/pmai/md5/actions/workflows/ci.yml/badge.svg)](https://github.com/pmai/md5/actions/workflows/ci.yml)
+
 This package implements The MD5 Message-Digest Algorithm, as defined
-in RFC 1321 by R. Rivest, published April 1992.
+in [RFC 1321][] by R. Rivest, published April 1992.
 
 It was originally written by Pierre R. Mai, with copious input from
 the cmucl-help mailing-list hosted at cons.org, in November 2001 and
@@ -9,7 +11,7 @@ been provided by Christophe Rhodes, Alexey Dejneka, Nathan Froyd,
 Andreas Fuchs, John Desoi, Dmitriy Ivanov, and Kevin M. Rosenberg, and
 have been reintegrated into this consolidated version by Pierre R. Mai.
 
-WARNING: The MD5 Message-Digest Algorithm has been compromised as a
+**WARNING:** The MD5 Message-Digest Algorithm has been compromised as a
 cryptographically secure hash for some time, with known theoretical
 and practical attacks.  Therefore use of this implemenation is only
 recommended for legacy uses or uses which do not require a
@@ -20,3 +22,5 @@ cryptographically secure for all other uses.
 This software is "as is", and has no warranty of any kind.  The
 authors assume no responsibility for the consequences of any use of
 this software.
+
+[RFC 1321]: https://tools.ietf.org/html/rfc1321

md5.asd

@@ -14,6 +14,10 @@
   :author "Pierre R. Mai <pmai@pmsf.de>"
   :maintainer "Pierre R. Mai <pmai@pmsf.de>"
   :licence "Public Domain"
-  :version "2.0.1"
+  :version "2.0.4"
-  #+sbcl :depends-on #+sbcl ("sb-rotate-byte")
+  :depends-on (#+sbcl "sb-rotate-byte"
+               #-(or :cmu :sbcl
+                     (and :lispworks (not :lispworks4))
+                     :ccl :allegro)
+               "flexi-streams")
   :components ((:file "md5")))

md5.lisp

@@ -87,7 +87,14 @@
 #+(and :lispworks (or (not :lispworks4) :lispworks4.4))
 (eval-when (:compile-toplevel :execute)
   (defparameter *old-features* *features*)
-  (pushnew :lw-int32 *features*))
+  (pushnew :lw-int32 *features*)
+  (defmacro lw-int32-no-overflow (value)
+    ;; Prevent overflow in 64-bit prior to LispWorks 7.0.
+    #+(and :lispworks-64bit (or :lispworks5 :lispworks6))
+    `(sys:int32>> (sys:int32<< ,value #.(sys:integer-to-int32 32))
+                  #.(sys:integer-to-int32 32))
+    #-(and :lispworks-64bit (or :lispworks5 :lispworks6))
+    value))
 
 ;;; Section 2:  Basic Datatypes
 
@@ -101,14 +108,16 @@
     "Assemble an ub32 value from the given (unsigned-byte 8) values,
 where a is the intended low-order byte and d the high-order byte."
     #+lw-int32
-    `(sys:int32-logior (sys:int32<< ,d 24)
+    `(lw-int32-no-overflow
-                       (sys:int32-logior (sys:int32<< ,c 16)
+      (sys:int32-logior (sys:int32<< ,d 24)
-                                         (sys:int32-logior (sys:int32<< ,b 8) ,a)))
+                        (sys:int32-logior (sys:int32<< ,c 16)
+                                          (sys:int32-logior (sys:int32<< ,b 8) ,a))))
     #-lw-int32
     `(the ub32 (logior (ash ,d 24) (ash ,c 16) (ash ,b 8) ,a))))
 
 (deftype ub32-vector (length)
-  #+lw-int32 `(sys:simple-int32-vector ,length)
+  #+lw-int32 (declare (ignore length))
+  #+lw-int32 'sys:simple-int32-vector
   #-lw-int32 `(simple-array (unsigned-byte 32) (,length)))
 
 (defmacro make-ub32-vector (length &rest args)
@@ -163,11 +172,8 @@ where a is the intended low-order byte and d the high-order byte."
            (optimize (speed 3) (safety 0) (space 0) (debug 0) #+lw-int32 (float 0)))
   #+cmu
   (kernel:32bit-logical-xor y (kernel:32bit-logical-orc2 x z))
-  #+(and :lw-int32 (not :lispworks-64bit))
+  #+lw-int32
-  (sys:int32-logxor y (sys:int32-logorc2 x z))
+  (lw-int32-no-overflow (sys:int32-logxor y (sys:int32-logorc2 x z)))
-  #+(and :lw-int32 :lispworks-64bit)
-  (sys:int32-logand #.(sys:int32-1+ (sys:int32<< (sys:integer-to-int32 #x7FFFFFFF) 1))
-                    (sys:int32-logxor y (sys:int32-logorc2 x z)))
   #-(or :cmu :lw-int32)
   (ldb (byte 32 0) (logxor y (logorc2 x z))))
 
@@ -176,11 +182,8 @@ where a is the intended low-order byte and d the high-order byte."
 (defun mod32+ (a b)
   (declare (type ub32 a b)
            (optimize (speed 3) (safety 0) (space 0) (debug 0) #+lw-int32 (float 0)))
-  #+(and :lw-int32 (not :lispworks-64bit))
+  #+lw-int32
-  (sys:int32+ a b)
+  (lw-int32-no-overflow (sys:int32+ a b))
-  #+(and :lw-int32 :lispworks-64bit)
-  (sys:int32-logand #.(sys:int32-1+ (sys:int32<< (sys:integer-to-int32 #x7FFFFFFF) 1))
-                    (sys:int32+ a b))
   #-lw-int32
   (ldb (byte 32 0) (+ a b)))
 
@@ -216,11 +219,8 @@ where a is the intended low-order byte and d the high-order byte."
                            (ash a (- s 32)))
   #+sbcl
   (sb-rotate-byte:rotate-byte s (byte 32 0) a)
-  #+(and :lw-int32 (not :lispworks-64bit))
+  #+lw-int32
-  (sys:int32-logior (sys:int32<< a s) (int32>>logical a (- 32 s)))
+  (sys:int32-logior (lw-int32-no-overflow (sys:int32<< a s))
-  #+(and :lw-int32 :lispworks-64bit)
-  (sys:int32-logior (sys:int32-logand #.(sys:int32-1+ (sys:int32<< (sys:integer-to-int32 #x7FFFFFFF) 1))
-                                      (sys:int32<< a s))
                     (int32>>logical a (- 32 s)))
   #-(or :cmu :sbcl :lw-int32)
   (logior (ldb (byte 32 0) (ash a s)) (ash a (- s 32))))
@@ -372,7 +372,7 @@ starting from `offset' into the given 16 word MD5 block."
    block (* vm:vector-data-offset vm:word-bits)
    (* 64 vm:byte-bits))
   #+(and :sbcl :little-endian)
-  (sb-kernel:ub8-bash-copy buffer offset block 0 64)
+  (sb-kernel:%byte-blt buffer offset block 0 64)
   #-(or (and :sbcl :little-endian) (and :cmu :little-endian))
   (loop for i of-type (integer 0 16) from 0
         for j of-type (integer 0 #.most-positive-fixnum)
@@ -397,8 +397,6 @@ starting from `offset' into the given 16 word MD5 block."
    buffer (+ (* vm:vector-data-offset vm:word-bits) (* offset vm:byte-bits))
    block (* vm:vector-data-offset vm:word-bits)
    (* 64 vm:byte-bits))
-  #+(and :sbcl :little-endian)
-  (sb-kernel:ub8-bash-copy buffer offset block 0 64)
   #-(or (and :sbcl :little-endian) (and :cmu :little-endian))
   (loop for i of-type (integer 0 16) from 0
         for j of-type (integer 0 #.most-positive-fixnum)
@@ -456,6 +454,9 @@ in `regs'.  Returns a (simple-array (unsigned-byte 8) (16))."
 
 ;;; Mid-Level Drivers
 
+(locally
+  (declare (optimize (speed 3) (safety 1) (space 0) (debug 1)
+                     #+lw-int32 (float 0)))
 (defstruct (md5-state
              (:constructor make-md5-state ())
              (:copier))
@@ -468,6 +469,7 @@ in `regs'.  Returns a (simple-array (unsigned-byte 8) (16))."
          :type (simple-array (unsigned-byte 8) (64)))
   (buffer-index 0 :type (integer 0 63))
   (finalized-p nil))
+)
 
 (declaim (inline copy-to-buffer))
 (defun copy-to-buffer (from from-offset count buffer buffer-offset)
@@ -672,7 +674,8 @@ positions in the string, not to octets in the resulting binary
 representation.  The permissible external format specifiers are
 determined by the underlying implementation."
   (declare (optimize (speed 3) (safety 3) (space 0) (debug 1))
-           (type string string) (type fixnum start))
+           (type string string) (type fixnum start)
+           (ignorable external-format))
   (locally
     (declare (optimize (safety 1) (debug 0)))
     #+cmu
@@ -706,7 +709,12 @@ determined by the underlying implementation."
     #-(or :cmu :sbcl (and :lispworks (not :lispworks4)) :ccl :allegro)
     (if (<= char-code-limit 256)
         (md5sum-sequence string :start start :end end)
-        (error "md5:md5sum-string is not supported for your implementation."))))
+        (md5sum-sequence
+         (flexi-streams:string-to-octets string
+                                         :external-format
+                                         (if (eq external-format :default)
+                                             :UTF-8
+                                             external-format))))))
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defconstant +buffer-size+ (* 128 1024)