pulsar::AuthOauth2 Class Reference

#include <Authentication.h>

Inheritance diagram for pulsar::AuthOauth2:

Public Member Functions
	AuthOauth2 (ParamMap &params)
const std::string	getAuthMethodName () const
Result	getAuthData (AuthenticationDataPtr &authDataOauth2)

Static Public Member Functions
static AuthenticationPtr	create (ParamMap &params)
static AuthenticationPtr	create (const std::string &authParamsString)
Static Public Member Functions inherited from pulsar::Authentication
static ParamMap	parseDefaultFormatAuthParams (const std::string &authParamsString)

Additional Inherited Members
Protected Attributes inherited from pulsar::Authentication
AuthenticationDataPtr	authData_

Detailed Description

Oauth2 based implementation of Pulsar client authentication. Passed in parameter would be like:

"type": "client_credentials",
"tokenEndpointAuthMethod": "client_secret_post",
"issuer_url": "https://accounts.google.com",
"client_id": "d9ZyX97q1ef8Cr81WHVC4hFQ64vSlDK3",
"client_secret": "on1uJ...k6F6R",
"audience": "https://broker.example.com"

For tokenEndpointAuthMethod = "tls_client_auth":

"type": "client_credentials",
"tokenEndpointAuthMethod": "tls_client_auth",
"issuer_url": "https://accounts.google.com",
"client_id": "d9ZyX97q1ef8Cr81WHVC4hFQ64vSlDK3",
"tls_cert_file": "/path/to/cert.pem",
"tls_key_file": "/path/to/key.pem"

If passed in as std::string, it should be in Json format.

Member Function Documentation

create() [1/2]

AuthenticationPtr pulsar::AuthOauth2::create ( const std::string & authParamsString )

static

Create an AuthOauth2 with an authentication parameter string

See also

Authentication::parseDefaultFormatAuthParams

create() [2/2]

AuthenticationPtr pulsar::AuthOauth2::create ( ParamMap & params )

static

Create an AuthOauth2 with a ParamMap

For tokenEndpointAuthMethod = "client_secret_post" (default), the required parameter keys are “issuer_url”, “private_key”, and “audience”. Optional keys: scope, tls_cert_file, tls_key_file.

For tokenEndpointAuthMethod = "tls_client_auth", the required parameter keys are issuer_url, tls_cert_file, and tls_key_file. Optional keys: client_id, audience, scope. If client_id is omitted, the client uses pulsar-client.

Parameters

parameters

the key-value to create OAuth 2.0 client credentials

See also

http://pulsar.apache.org/docs/en/security-oauth2/#client-credentials

getAuthData()

Result pulsar::AuthOauth2::getAuthData ( AuthenticationDataPtr & authDataOauth2 )

virtual

Get AuthenticationData from the current instance

Parameters

[out]

authDataOauth2

the shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.

Returns

ResultOk or ResultAuthenticationError if authentication failed

Reimplemented from pulsar::Authentication.

getAuthMethodName()

const std::string pulsar::AuthOauth2::getAuthMethodName ( ) const

virtual

Returns

“token”

Implements pulsar::Authentication.

---

The documentation for this class was generated from the following file:

• include/pulsar/Authentication.h