Add SASL SCRAM-SHA-256 support.

* lisp/net/sasl.el (sasl-mechanisms): Add SCRAM-SHA-256.
(sasl-mechanism-alist): Ditto.
* lisp/net/sasl-scram-sha256.el: New file.
* tests/lisp/net/sasl-scram-rfc-tests.el (sasl-scram-sha-256-test):
New function.
This commit is contained in:
Simon Josefsson 2020-01-03 18:41:03 +01:00
parent 125bc5b1a4
commit f7ff3ddc16
No known key found for this signature in database
GPG key ID: 51722B08FE4745A2
3 changed files with 86 additions and 4 deletions

View file

@ -0,0 +1,59 @@
;;; sasl-scram-sha256.el --- SCRAM-SHA-256 module for the SASL client framework -*- lexical-binding: t; -*-
;; Copyright (C) 2020 Free Software Foundation, Inc.
;; Author: Simon Josefsson <simon@josefsson.org>
;; Package: sasl
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Implement the SCRAM-SHA-256 mechanism from RFC 7677.
;;; Code:
(require 'cl-lib)
(require 'sasl)
(require 'hex-util)
(require 'rfc2104)
(require 'sasl-scram-rfc)
;;; SCRAM-SHA-256
(defconst sasl-scram-sha-256-steps
'(sasl-scram-client-first-message
sasl-scram-sha-256-client-final-message
sasl-scram-sha-256-authenticate-server))
(defun sasl-scram-sha256 (object &optional start end binary)
(secure-hash 'sha256 object start end binary))
(defun sasl-scram-sha-256-client-final-message (client step)
(sasl-scram--client-final-message
;; HMAC-SHA256 uses block length 64 and hash length 32; see RFC 4634.
'sasl-scram-sha256 64 32 client step))
(defun sasl-scram-sha-256-authenticate-server (client step)
(sasl-scram--authenticate-server
'sasl-scram-sha256 64 32 client step))
(put 'sasl-scram-sha256 'sasl-mechanism
(sasl-make-mechanism "SCRAM-SHA-256" sasl-scram-sha-256-steps))
(provide 'sasl-scram-sha256)
;;; sasl-scram-sha256.el ends here

View file

@ -35,8 +35,8 @@
;;; Code:
(defvar sasl-mechanisms
'("SCRAM-SHA-1" "CRAM-MD5" "DIGEST-MD5" "PLAIN" "LOGIN" "ANONYMOUS"
"NTLM"))
'("SCRAM-SHA-256" "SCRAM-SHA-1" "CRAM-MD5" "DIGEST-MD5" "PLAIN" "LOGIN"
"ANONYMOUS" "NTLM"))
(defvar sasl-mechanism-alist
'(("CRAM-MD5" sasl-cram)
@ -45,6 +45,7 @@
("LOGIN" sasl-login)
("ANONYMOUS" sasl-anonymous)
("NTLM" sasl-ntlm)
("SCRAM-SHA-256" sasl-scram-sha256)
("SCRAM-SHA-1" sasl-scram-rfc)))
(defvar sasl-unique-id-function #'sasl-unique-id-function)

View file

@ -1,4 +1,4 @@
;;; sasl-scram-rfc-tests.el --- tests for SCRAM-SHA-1 -*- lexical-binding: t; -*-
;;; sasl-scram-rfc-tests.el --- tests for SCRAM -*- lexical-binding: t; -*-
;; Copyright (C) 2014-2020 Free Software Foundation, Inc.
@ -19,7 +19,7 @@
;;; Commentary:
;; Test cases from RFC 5802.
;; Test cases from RFC 5802 and RFC 7677.
;;; Code:
@ -47,4 +47,26 @@
(sasl-scram-sha-1-authenticate-server client (vector nil "v=rmF9pqV8S7suAoZWja4dJRkFsKQ=
"))))
(require 'sasl-scram-sha256)
(ert-deftest sasl-scram-sha-256-test ()
;; The following strings are taken from section 3 of RFC 7677.
(let ((client
(sasl-make-client (sasl-find-mechanism '("SCRAM-SHA-256"))
"user"
"imap"
"localhost"))
(data "r=rOprNGfwEbeRWgbNEkqO%hvYDpWUa2RaTCAfuxFIlj)hNlF$k0,s=W22ZaJ0SNY7soEsUEjb6gQ==,i=4096")
(c-nonce "rOprNGfwEbeRWgbNEkqO")
(sasl-read-passphrase
(lambda (_prompt) (copy-sequence "pencil"))))
(sasl-client-set-property client 'c-nonce c-nonce)
(should
(equal
(sasl-scram-sha-256-client-final-message client (vector nil data))
"c=biws,r=rOprNGfwEbeRWgbNEkqO%hvYDpWUa2RaTCAfuxFIlj)hNlF$k0,p=dHzbZapWIk4jUhN+Ute9ytag9zjfMHgsqmmiz7AndVQ="))
;; This should not throw an error:
(sasl-scram-sha-256-authenticate-server client (vector nil "v=6rriTRBi23WpRR/wtup+mMhUZUn/dB5nLTJRsjl95G4="))))
;;; sasl-scram-rfc-tests.el ends here