Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Copyright 2015-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Copyright: 2015-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 270 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Auth_Scram:: (5 methods):
  __construct()
  getClientFirstMessage()
  parseServerFirstMessage()
  getClientFinalMessage()
  parseServerFinalMessage()


Class: Horde_Imap_Client_Auth_Scram  - X-Ref

Provides authentication via the SCRAM SASL mechanism (RFC 5802 [3]).

__construct($user, $pass, $hash = 'SHA1')   X-Ref
Constructor.

param: string $user  Username.
param: string $pass  Password.
param: string $hash  Hash name.

getClientFirstMessage()   X-Ref
Return the initial client message.

return: string  Initial client message.

parseServerFirstMessage($msg)   X-Ref
Process the initial server message response.

param: string $msg  Initial server response.
return: boolean  False if authentication failed at this stage.

getClientFinalMessage()   X-Ref
Return the final client message.

return: string  Final client message.

parseServerFinalMessage($msg)   X-Ref
Process the final server message response.

param: string $msg  Final server response.
return: boolean  False if authentication failed.