summaryrefslogtreecommitdiff
path: root/src/eris.lisp
blob: 5e3ed2a2d18a977bfddf624133543d657848193a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
;; This file is part of eris-cl.
;; Copyright (C) 2022 Piotr Szarmański

;; eris-cl is free software: you can redistribute it and/or modify it under the
;; terms of the GNU Lesser General Public License as published by the Free
;; Software Foundation, either version 3 of the License, or (at your option) any
;; later versqion.

;; eris-cl is distributed in the hope that it will be useful, but WITHOUT ANY
;; WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
;; A PARTICULAR PURPOSE. See the GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License along with
;; eris-cl. If not, see <https://www.gnu.org/licenses/>.

(in-package :eris)

(deftype block-size ()
        `(member 1024 32768))

(defconstant 32kib 32768)
(defconstant 1kib 1024)

(eval-when
    (:execute :load-toplevel :compile-toplevel)
  (defclass reference-pair ()
    ((reference :initarg :reference :accessor reference :type (simple-array (unsigned-byte 8) 32))
     (key :initarg :key :accessor key :type (simple-array (unsigned-byte 8) 32)))))

(define-constant null-secret (make-array 32 :element-type '(unsigned-byte 8) :initial-element 0)
  :test #'equalp
  :documentation
  "32-byte null vector.")

(defun reference-pair-to-octets (pair buf &optional (start 0))
  "Convert a reference-pair object PAIR into the standard binary representation by
filling the buffer BUF from the START keyword argument. "
  (declare (type vector buf))
  (replace buf (reference pair) :start1 start)
    (replace buf (key pair) :start1 (+ 32 start)))

(defun octets-to-reference-pair (octets &optional (start 0))
  "Convert the standard reference-pair binary representation into a reference-pair
object, using the bytes from the OCTETS vector from at START."
  (declare (type vector octets))
  (make-instance 'reference-pair :key (subseq octets (+ 32 start) (+ 64 start))
                                 :reference (subseq octets start (+ 32 start))))


(defun compute-reference (block)
  (declare (type (simple-array (unsigned-byte 8)) block))
  (let ((reference (make-array 32 :element-type '(unsigned-byte 8))))
    (ironclad:digest-sequence :blake2/256 block :digest reference)
    reference))

(defun make-nonce (level)
  (let ((nonce (make-array 12 :element-type '(unsigned-byte 8) :initial-element 0)))
    (setf (aref nonce 0) level)
    nonce))

(defun encrypt-block (input secret reference)
  (declare (type (simple-array (unsigned-byte 8)) input secret reference))
  (let ((mac (ironclad:make-mac :blake2-mac secret :digest-length 32))
        (key (make-array 32 :element-type '(unsigned-byte 8))))
    (ironclad:update-mac mac input)
    (ironclad:produce-mac mac :digest key)
    ;; NOT the IETF chacha. Need to fix this by patching ironclad. Maybe.
    (ironclad:encrypt-in-place (ironclad:make-cipher :chacha :mode :stream :key key
                                                             :initialization-vector null-secret)
                               input)
    (ironclad:digest-sequence :blake2/256 input :digest reference)
    (make-instance 'reference-pair :key key :reference reference)))

(defun encrypt-internal-block (input reference nonce)
  (declare (type (simple-array (unsigned-byte 8)) input secret reference))
  (let ((key (make-array 32 :element-type '(unsigned-byte 8))))
    (ironclad:digest-sequence :blake2/256 input :digest key)
    ;; NOT the IETF chacha. Need to fix this by patching ironclad. Maybe.
    (ironclad:encrypt-in-place (ironclad:make-cipher :chacha :mode :stream :key key
                                                             :initialization-vector nonce)
                               input)
    (ironclad:digest-sequence :blake2/256 input :digest reference)
    (make-instance 'reference-pair :key key :reference reference)))

(defun decrypt-block (input key &optional (nonce null-secret))
  (ironclad:decrypt-in-place
   (ironclad:make-cipher :chacha :mode :stream :key key :initialization-vector nonce)
   input)
  input)


(defclass read-capability ()
  ((block-size :initarg :block-size
               :accessor block-size
               :type block-size
               :documentation "A value of either 1024 or 1kb blocks.") 
   (level :initarg :level :accessor level :type (unsigned-byte 8))
   (root-reference-pair :initarg :reference-pair :accessor reference-pair))
  (:documentation "Class representing the concept of an ERIS read capability."))

(declaim
 (ftype (function (read-capability) (values (simple-array (unsigned-byte 8) (66)) &optional)) read-capability-to-octets)
 (ftype (function ((simple-array (unsigned-byte 8) (66))) read-capability) octets-to-read-capability)
 (ftype (function (read-capability) string) read-capability-to-urn)
 (ftype (function (string) read-capability) urn-to-read-capability)
 (ftype (function ((simple-array (unsigned-byte 8) (32))) string) reference-to-block-urn)
 (ftype (function (string) (values (simple-array (unsigned-byte 8) (32)) &optional)) block-urn-to-reference))

(defun read-capability-to-octets (read-capability)
  "Convert a read-capability object to its standard binary representation. Returns
a (simple-array (unsigned-byte 8)) object."
  (declare (type read-capability read-capability))
  (let ((cap (make-array 66 :element-type '(unsigned-byte 8))))
    (case (block-size read-capability) ;; This depends on the version of the standard
      (1024 (setf (aref cap 0) #x0a))
      (32768 (setf (aref cap 0) #x0f)))
    (setf (aref cap 1) (level read-capability))
    (reference-pair-to-octets (reference-pair read-capability) cap 2)))

(defun octets-to-read-capability (octets)
  "Convert the standard binary representation for ERIS read capabilities into a
read-capability object. Returns the read-capability."
  (declare (type (simple-array (unsigned-byte 8) (66)) octets))
  (let ((capability (make-instance 'read-capability)))
    (setf (block-size capability)
          (case (aref octets 0)
            (#x0a 1kib)
            (#x0f 32kib)
            (t (error 'version-mismatch))))
    (setf (level capability)
          (aref octets 1))
    (setf (reference-pair capability)
          (octets-to-reference-pair octets 2))
    capability))

(defun read-capability-to-urn (capability)
  "Convert a read-capability object into a URN string."
  (declare (type read-capability capability))
  (concatenate 'string
               "urn:eris:"
               (bytes-to-base32-unpadded (read-capability-to-octets capability))))

(defun urn-to-read-capability (urn)
  "Convert a urn:eris URN string into a read-capability object."
  (declare (type string urn))
  (octets-to-read-capability (base32-to-bytes-unpadded (subseq urn (1+ (position #\: urn :from-end t))))))

(defun reference-to-block-urn (reference)
  "Convert a 32-byte block reference into a URN string."
  (declare (type (simple-array (unsigned-byte 8) (32)) reference))
  (concatenate 'string "urn:blake2b:" (bytes-to-base32-unpadded reference)))

(defun block-urn-to-reference (urn)
  "Convert a urn:blake2b URN string into a 32-byte block reference vector."
  (declare (type string urn))
  (base32-to-bytes-unpadded (subseq urn (1+ (position #\: urn :from-end t)))))

(defun pad (input block-size)
  (declare (type (simple-array (unsigned-byte 8)) input)
           (type integer block-size))
  (let* ((pad-size (- block-size (mod (length input) block-size)))
         (padded-input (adjust-array input (+ pad-size (length input)) :initial-element 0)))
    (replace padded-input input)
    (setf (aref padded-input (length input)) #x80)
    padded-input))

(defvar *output-hashmap* nil)

(defmacro output-block (ref-vector &rest expr)
  `(let ((reference (compute-reference block)))
     (if hash-output
         (unless (gethash reference *output-hashmap*)
           (let ((rk (encrypt-block block secret reference)))
             (vector-push-extend rk ,ref-vector)
             (funcall output-function block (reference rk))
             (setf (gethash reference *output-hashmap*) t)))
         (let ((rk (encrypt-block block secret reference)))
           (vector-push-extend rk ,ref-vector)
           (funcall output-function block (reference rk))))
     ,@expr))

(defmacro output-internal-block (ref-vector nonce &rest expr)
  `(let ((reference (compute-reference block)))
     (if hash-output
         (unless (gethash reference *output-hashmap*)
           (let ((rk (encrypt-internal-block block reference ,nonce)))
             (vector-push-extend rk ,ref-vector)
             (funcall output-function block (reference rk))
             (setf (gethash reference *output-hashmap*) t)))
         (let ((rk (encrypt-internal-block block reference ,nonce)))
           (vector-push-extend rk ,ref-vector)
           (funcall output-function block (reference rk))))
     ,@expr))

(defgeneric eris-encode (input block-size output-function &key secret hash-output)
  (:documentation
   "Encode an input into block-size (32kib or 1kib) blocks, that are output using
the function output-function. This function wil be called with two arguments: an
encoded block and a 32-byte reference octet vector.

An optional 32-byte secret can be passed for additional encryption using the
:secret keyword."))

(defmethod eris-encode ((input simple-array) block-size output-function &key (secret null-secret) hash-output)
  (declare (type block-size block-size)
           (type function output-function)
           (type (simple-array (unsigned-byte 8) (32)) secret))

  (setf input (pad input block-size)) 
  
  (let ((reference-vector (make-array 16 :adjustable t :fill-pointer 0))
        (*output-hashmap* (if hash-output (make-hash-table :test #'equalp) nil)))
    (loop for block = (make-array block-size :element-type '(unsigned-byte 8) :initial-element 0)
          for i = 0 then (incf i)
          until (= (length input) (* i block-size)) 
          do (progn
               (replace block input :start2 (* i block-size))
               (output-block reference-vector nil)))
    (eris-create-tree reference-vector block-size output-function :hash-output hash-output)))

(defmethod eris-encode ((input stream) block-size output-function &key (secret null-secret) hash-output)
  (declare (type block-size block-size)
           (type function output-function)
           (type (simple-array (unsigned-byte 8) (32)) secret))
  (let ((reference-vector (make-array 16 :adjustable t :fill-pointer 0))
        (*output-hashmap* (if hash-output (make-hash-table :test #'equalp) nil)))
    (loop for block = (make-array block-size :element-type '(unsigned-byte 8) :initial-element 0)
          for bytes-read = (read-sequence block input)
          for i = 0 then (incf i)
          if (< bytes-read block-size)
            do (setf (aref block bytes-read) #x80)
          do (output-block reference-vector nil)
          until (< bytes-read block-size))
    (eris-create-tree reference-vector block-size output-function :hash-output hash-output)))

(defun eris-create-tree (reference-vector block-size output-function &key hash-output)
  (declare (type block-size block-size)
           (type function output-function)
           (type (simple-array (unsigned-byte 8) (32)) secret))
  (loop with block-keys = (/ block-size 64)
        with level = 0
        with reference-vector-l = (make-array 16 :adjustable t :fill-pointer 0)
        for nonce = (make-nonce (1+ level))
        when (eql (length reference-vector) 1)
        do (return (make-instance 'read-capability
                                  :reference-pair (aref reference-vector 0)
                                  :level level
                                  :block-size block-size)) 
        do (progn
             (incf level)
             ;; loop across the key-reference vector and build the tree
             (loop with block = (make-array block-size :element-type '(unsigned-byte 8) :initial-element 0)
                   for rk across reference-vector
                   with i = 0
                   when (eql i block-keys)
                     do (output-internal-block reference-vector-l nonce
                                               (setf block (make-array block-size :element-type '(unsigned-byte 8) :initial-element 0)
                                                     i 0))
                   do (progn (reference-pair-to-octets rk block (* 64 i))
                             (incf i))
                   finally (unless (zerop i)
                             ;; If i is zero, then the amount of blocks is just right. Otherwise add a final unfinished block.
                             (output-internal-block reference-vector-l nonce)))
             (setf reference-vector reference-vector-l)
             (setf reference-vector-l (make-array 16 :adjustable t :fill-pointer 0)))))