CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
        • Exception
      • Cookie
      • Exception
      • Middleware
      • Session
      • TestSuite
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class Digest

Digest authentication adapter for Cake\Http\Client

Generally not directly constructed, but instead used by {@link \Cake\Http\Client} when $options['auth']['type'] is 'digest'

Namespace: Cake\Http\Client\Auth

Constants

  • ALGO_MD5 ¶
    'MD5'

    Algorithms

  • ALGO_MD5_SESS ¶
    'MD5-sess'
  • ALGO_SHA_256 ¶
    'SHA-256'
  • ALGO_SHA_256_SESS ¶
    'SHA-256-sess'
  • ALGO_SHA_512_256 ¶
    'SHA-512-256'
  • ALGO_SHA_512_256_SESS ¶
    'SHA-512-256-sess'
  • HASH_ALGORITHMS ¶
    [self::ALGO_MD5 => 'md5', self::ALGO_SHA_256 => 'sha256', self::ALGO_SHA_512_256 => 'sha512/256', self::ALGO_MD5_SESS => 'md5', self::ALGO_SHA_256_SESS => 'sha256', self::ALGO_SHA_512_256_SESS => 'sha512/256']

    Algorithms <-> Hash type

  • QOP_AUTH ¶
    'auth'

    QOP

  • QOP_AUTH_INT ¶
    'auth-int'

Property Summary

  • $_client protected
    Cake\Http\Client

    Instance of Cake\Http\Client

  • $algorithm protected
    string

    Algorithm

  • $hashType protected
    string

    Hash type

  • $isSessAlgorithm protected
    bool

    Is Sess algorithm

Method Summary

  • __construct() public

    Constructor

  • _generateHeader() protected

    Generate the header Authorization

  • _getServerInfo() protected

    Retrieve information about the authentication

  • authentication() public

    Add Authorization header to the request.

  • generateCnonce() protected
  • setAlgorithm() protected

    Set algorithm based on credentials

Method Detail

__construct() ¶ public

__construct(Cake\Http\Client $client, array|null $options = null)

Constructor

Parameters
Cake\Http\Client $client

Http client object.

array|null $options optional

Options list.

_generateHeader() ¶ protected

_generateHeader(Cake\Http\Client\Request $request, array<string, mixed> $credentials): string

Generate the header Authorization

Parameters
Cake\Http\Client\Request $request

The request object.

array<string, mixed> $credentials

Authentication credentials.

Returns
string

_getServerInfo() ¶ protected

_getServerInfo(Cake\Http\Client\Request $request, array $credentials): array

Retrieve information about the authentication

Will get the realm and other tokens by performing another request without authentication to get authentication challenge.

Parameters
Cake\Http\Client\Request $request

The request object.

array $credentials

Authentication credentials.

Returns
array

authentication() ¶ public

authentication(Cake\Http\Client\Request $request, array<string, mixed> $credentials): Cake\Http\Client\Request

Add Authorization header to the request.

Parameters
Cake\Http\Client\Request $request

The request object.

array<string, mixed> $credentials

Authentication credentials.

Returns
Cake\Http\Client\Request
See Also
https://www.ietf.org/rfc/rfc2617.txt

generateCnonce() ¶ protected

generateCnonce(): string
Returns
string

setAlgorithm() ¶ protected

setAlgorithm(array $credentials): void

Set algorithm based on credentials

Parameters
array $credentials

authentication params

Returns
void

Property Detail

$_client ¶ protected

Instance of Cake\Http\Client

Type
Cake\Http\Client

$algorithm ¶ protected

Algorithm

Type
string

$hashType ¶ protected

Hash type

Type
string

$isSessAlgorithm ¶ protected

Is Sess algorithm

Type
bool
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs