Classes, interfaces and traits

AuthOptions

A common base object for authentication options.<p>

« More »

AuthProvider

User-facing interface for authenticating users.

« More »

ChainAuth

Chain several auth providers as if they were one. This is useful for cases where one want to authenticate across several providers, for example, database and fallback to passwd file.

« More »

HashingAlgorithm

Hashing Algorithm. A common interface to interact with any system provided algorithms.

« More »

HashingStrategy

Hashing Strategy manager.

This class will load system provided hashing strategies and algorithms.

« More »

KeyStoreOptions

Options describing how an JWT KeyStore should behave.

« More »

PubSecKeyOptions

Options describing how a Cryptographic Key.

« More »

SecretOptions

Options describing a secret.

« More »

User

Represents an authenticates User and contains operations to authorise the user.

Please consult the documentation for a detailed explanation.

« More »

VertxContextPRNG

A secure non blocking random number generator isolated to the current context. The PRNG is bound to the vert.x context and setup to close when the context shuts down.

When applicable, use of VertxContextPRNG rather than create new PRNG objects is helpful to keep the system entropy usage to the minimum avoiding potential blocking across the application.

The use of VertxContextPRNG is particularly appropriate when multiple handlers use random numbers.

« More »

Classes, interfaces and traits

HtdigestAuth

An extension of AuthProvider which is using .htdigest file as store

« More »

Classes, interfaces and traits

HtpasswdAuth

An extension of AuthProvider which is using htpasswd file as store

« More »

HtpasswdAuthOptions

Options configuring htpasswd authentication.

« More »

Classes, interfaces and traits

JDBCAuth

Factory interface for creating @see \io\vertx\jphp\ext\auth\AuthProvider instances that use the Vert.x JDBC client.

By default the hashing strategy is SHA-512. If you're already running in production this is backwards compatible, however for new deployments or security upgrades it is recommended to use the PBKDF2 strategy as it is the current OWASP recommendation for password storage.

« More »

JDBCAuthOptions

Options configuring JDBC authentication.

« More »

JDBCHashStrategy

Determines how the hashing is computed in the implementation

You can implement this to provide a different hashing strategy to the default.

« More »

Classes, interfaces and traits

JWTAuth

Factory interface for creating JWT based @see \io\vertx\jphp\ext\auth\AuthProvider instances.

« More »

JWTAuthOptions

Options describing how an JWT Auth should behave.

« More »

JWTKeyStoreOptions

Options describing how an JWT KeyStore should behave.

« More »

JWTOptions

Options related to creation of new tokens.

If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload.

Generated JWTs will include an iat claim by default unless noTimestamp is specified.

« More »

Classes, interfaces and traits

HashStrategy

Determines how the hashing is computed in the implementation You can implement this to provide a different hashing strategy to the default.

« More »

MongoAuth

An extension of AuthProvider which is using as store

« More »

MongoAuthOptions

Options configuring Mongo authentication.

« More »

Classes, interfaces and traits

AccessToken

AccessToken extension to the User interface

« More »

KeycloakHelper

Helper class for processing Keycloak principal.

« More »

OAuth2Auth

Factory interface for creating OAuth2 based @see \io\vertx\jphp\ext\auth\AuthProvider instances.

« More »

OAuth2ClientOptions

Options describing how an OAuth2 will make connections.

« More »

OAuth2RBAC

Functional interface that allows users to implement custom RBAC verifiers for OAuth2/OpenId Connect.

Users are to implement the isAuthorized method to verify authorities. For provides that do not export the permissions/roles in the token, this interface allows you to communicate with 3rd party services such as graph APIs to collect the required data.

The contract is that once an authority is checked for a given user, it's value is cached during the execution of the request. If a user is stored to a persistent storage, or the token is introspected, the cache is cleared and a new call will be handled to the implementation.

« More »

OAuth2Response

A response from a fetch request.

This class represents a secure response from a Oauth2 fetch call.

A fetch is a simplified HTTP response from a protected resource.

« More »

Classes, interfaces and traits

AzureADAuth

Simplified factory to create an for Azure AD.

« More »

BoxAuth

Simplified factory to create an for box.com.

« More »

CloudFoundryAuth

Simplified factory to create an for CloudFoundry UAA.

« More »

DropboxAuth

Simplified factory to create an for Dropbox.

« More »

FacebookAuth

Simplified factory to create an for Facebook.

« More »

FoursquareAuth

Simplified factory to create an for Foursquare.

« More »

GithubAuth

Simplified factory to create an for Github.

« More »

GoogleAuth

Simplified factory to create an @see \io\vertx\jphp\ext\auth\oauth2\OAuth2Auth for Google.

« More »

HerokuAuth

Simplified factory to create an for Heroku.

« More »

InstagramAuth

Simplified factory to create an for Instagram.

« More »

KeycloakAuth

Simplified factory to create an for Keycloak.

« More »

LinkedInAuth

Simplified factory to create an for LinkedIn.

« More »

LiveAuth

Simplified factory to create an for live.com Services.

« More »

MailchimpAuth

Simplified factory to create an for Mailchimp.

« More »

OpenIDConnectAuth

Simplified factory to create an @see \io\vertx\jphp\ext\auth\oauth2\OAuth2Auth for OpenID Connect.

« More »

SalesforceAuth

Simplified factory to create an for Salesforce.

« More »

ShopifyAuth

Simplified factory to create an for Shopify.

« More »

SoundcloudAuth

Simplified factory to create an for SoundCloud.

« More »

StripeAuth

Simplified factory to create an for Stripe.

« More »

TwitterAuth

Simplified factory to create an for Twitter.

« More »

Classes, interfaces and traits

KeycloakRBAC

Implementation of the Keycloak RBAC handler.

« More »

MicroProfileRBAC

Implementation of the Microprofile MP-JWT 1.1 RBAC based on the access token groups key.

« More »

Classes, interfaces and traits

ShiroAuth

Factory interface for creating Apache Shiro based @see \io\vertx\jphp\ext\auth\AuthProvider instances.

« More »

ShiroAuthOptions

Shiro auth configuration options, see Vert.x Auth Shiro component and/or Apache Shiro project.

« More »