1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

[ruby/net-imap] Clean up authenticators rdoc

Added RFC links to all SASL mechanism specifications.

53ff4b0c09
This commit is contained in:
nicholas a. evans 2021-04-28 17:43:34 -04:00 committed by Hiroshi SHIBATA
parent 912f39b2c3
commit 2fc91da86c
No known key found for this signature in database
GPG key ID: F9CF13417264FAC2
5 changed files with 36 additions and 18 deletions

View file

@ -1,14 +1,21 @@
# frozen_string_literal: true
# Authenticator for the "+PLAIN+" SASL mechanism. See Net::IMAP#authenticate.
# Authenticator for the "+PLAIN+" SASL mechanism, specified in
# RFC4616[https://tools.ietf.org/html/rfc4616]. See Net::IMAP#authenticate.
#
# See RFC4616[https://tools.ietf.org/html/rfc4616] for the specification.
# +PLAIN+ authentication sends the password in cleartext.
# RFC3501[https://tools.ietf.org/html/rfc3501] encourages servers to disable
# cleartext authentication until after TLS has been negotiated.
# RFC8314[https://tools.ietf.org/html/rfc8314] recommends TLS version 1.2 or
# greater be used for all traffic, and deprecate cleartext access ASAP. +PLAIN+
# can be secured by TLS encryption.
class Net::IMAP::PlainAuthenticator
def process(data)
return "#@authzid\0#@username\0#@password"
end
# :nodoc:
NULL = -"\0".b
private