PHP-OAuth

Basics

  • Overview
    • Features
    • Requirements
    • Supported Providers
    • Shameless advertising
  • Installation
    • Installation with Composer
      • composer.json
      • Terminal
    • Manual installation
      • Can I use this library without using composer?
  • Configuration settings
    • key
    • secret
    • callbackURL
    • useStorageEncryption
    • storageEncryptionKey
    • tokenAutoRefresh
    • sessionStart
    • sessionStop
    • sessionStorageVar
    • fileStoragePath
    • pkceVerifierLength

Usage

  • Quickstart
    • The OAuthOptions container
    • The OAuthStorageInterface
      • Using existing tokens
    • Provider invocation
      • Provider factory
  • Authorization flow
    • Redirect the user to the provider
      • Present a log-in link
      • Redirect
    • Receive the incoming callback
      • OAuth2
      • OAuth1
    • Use the provider’s API
  • Using the examples
    • Requirements
      • Server
      • Dependencies
      • Configuration
    • Run the authorization flow
      • Call chain

Development

  • Create your own provider class
    • Minimal implementation
      • Dynamic URLs
    • Informational values
    • Additional headers
    • Scopes
    • Request authorization method (OAuth2)
    • Overriding methods
      • OAuth1
      • OAuth2
  • Additional provider functionality
    • UserInfo
    • ClientCredentials (OAuth2)
    • CSRFToken (OAuth2)
    • TokenRefresh (OAuth2)
    • PKCE (OAuth2)
    • PAR (OAuth2)
    • TokenInvalidate
  • Create your own tests
    • Unit test
    • Live test
      • Import existing tokens
  • Running the test suite
    • Control test behaviour
    • Using custom PSR-17/PSR-18 factories

Appendix

  • How to contribute
    • Questions and issues
    • Bug reports
    • Pull requests and bug fixes
    • Documentation
  • License
PHP-OAuth
  • Search

© Copyright 2024, smiley.