serv/mox
1
0
Fork 0
mirror of https://github.com/mjl-/mox.git synced 2024-12-25 07:53:47 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

tweak doucmentation for sasl and scram

Browse source
This commit is contained in:
Mechiel Lukkien 2024-12-06 15:59:22 +01:00
parent ce75852b7c
commit 0a77bc5955
No known key found for this signature in database
2 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
sasl/sasl.go
View file

@ -1,4 +1,15 @@
// Package SASL implements Simple Authentication and Security Layer, RFC 4422.
// Package SASL implements a client for Simple Authentication and Security Layer, RFC 4422.
//
// Supported authentication mechanisms:
//
// - EXTERNAL
// - SCRAM-SHA-256-PLUS
// - SCRAM-SHA-1-PLUS
// - SCRAM-SHA-256
// - SCRAM-SHA-1
// - CRAM-MD5
// - PLAIN
// - LOGIN
package sasl
import (

7
scram/scram.go
View file

@ -1,9 +1,10 @@
// Package scram implements the SCRAM-SHA-* SASL authentication mechanism, RFC 7677 and RFC 5802.
// Package scram implements the SCRAM-SHA-* SASL authentication mechanisms, including the PLUS variants, RFC 7677 and RFC 5802.
//
// SCRAM-SHA-256 and SCRAM-SHA-1 allow a client to authenticate to a server using a
// password without handing plaintext password over to the server. The client also
// verifies the server knows (a derivative of) the password. Both the client and
// server side are implemented.
// verifies the server knows (a derivative of) the password. The *-PLUS variants
// bind the authentication exchange to the TLS session, preventing MitM attempts.
// Both the client and server side are implemented.
package scram
// todo: test with messages that contains extensions