goa_oauth2_provider_get_authorization_uri ()

const gchar *
goa_oauth2_provider_get_authorization_uri
                               (GoaOAuth2Provider *provider);

Gets the authorization endpoint used for authenticating the user and obtaining authorization.

You should not include any parameters in the returned URI. If you need to include additional parameters than the standard ones, override GoaOAuth2ProviderClass.build_authorization_uri - see goa_oauth2_provider_build_authorization_uri() for more details.

This is a pure virtual method - a subclass must provide an implementation.

goa_oauth2_provider_get_token_uri ()

const gchar *
goa_oauth2_provider_get_token_uri (GoaOAuth2Provider *provider);

Gets the token endpoint used for obtaining an access token.

A token URI is only needed when the OAuth2 provider does not support a separate client-side flow. In such cases, override GoaOAuth2ProviderClass.get_token_uri. You should not include any parameters in the returned URI.

This is a virtual method where the default implementation returns NULL.

goa_oauth2_provider_get_redirect_uri ()

const gchar *
goa_oauth2_provider_get_redirect_uri (GoaOAuth2Provider *provider);

Gets the redirect_uri used when requesting authorization.

This is a pure virtual method - a subclass must provide an implementation.

goa_oauth2_provider_get_scope ()

const gchar *
goa_oauth2_provider_get_scope (GoaOAuth2Provider *provider);

Gets the scope used when requesting authorization.

This is a virtual method where the default implementation returns NULL.

goa_oauth2_provider_get_client_id ()

const gchar *
goa_oauth2_provider_get_client_id (GoaOAuth2Provider *provider);

Gets the client_id identifying the client.

This is a pure virtual method - a subclass must provide an implementation.

goa_oauth2_provider_get_client_secret ()

const gchar *
goa_oauth2_provider_get_client_secret (GoaOAuth2Provider *provider);

Gets the client_secret associated with the client.

This is a pure virtual method - a subclass must provide an implementation.

goa_oauth2_provider_get_use_mobile_browser ()

gboolean
goa_oauth2_provider_get_use_mobile_browser
                               (GoaOAuth2Provider *provider);

Returns whether there is a need for the embedded browser to identify itself as running on a mobile phone in order to get a more compact version of the approval page.

This is a virtual method where the default implementation returns FALSE.

goa_oauth2_provider_is_deny_node ()

gboolean
goa_oauth2_provider_is_deny_node (GoaOAuth2Provider *provider,
                                  WebKitDOMNode *node);

Checks whether node is the HTML UI element that the user can use to deny permission to access his account. Usually they are either a WebKitDOMHTMLButtonElement or a WebKitDOMHTMLInputElement.

Please note that providers may have multiple such elements in their UI and this method should catch all of them.

This is a virtual method where the default implementation returns FALSE.

goa_oauth2_provider_is_identity_node ()

gboolean
goa_oauth2_provider_is_identity_node (GoaOAuth2Provider *provider,
                                      WebKitDOMHTMLInputElement *element);

Checks whether element is the HTML UI element that the user can use to identify herself at the provider.

This is a pure virtual method - a subclass must provide an implementation.

goa_oauth2_provider_is_password_node ()

gboolean
goa_oauth2_provider_is_password_node (GoaOAuth2Provider *provider,
                                      WebKitDOMHTMLInputElement *element);

Checks whether element is the HTML UI element that the user can use to enter her password. This can be used to offer a GoaPasswordBased interface by saving the user's password. Providers usually frown upon doing this, so this is not recommended.

This is a virtual method where the default implementation returns FALSE.

goa_oauth2_provider_build_authorization_uri ()

gchar *
goa_oauth2_provider_build_authorization_uri
                               (GoaOAuth2Provider *provider,
                                const gchar *authorization_uri,
                                const gchar *escaped_redirect_uri,
                                const gchar *escaped_client_id,
                                const gchar *escaped_scope);

Builds the URI that can be opened in a web browser (or embedded web browser widget) to start authenticating an user.

The default implementation just returns the expected URI (e.g. http://example.com/dialog/oauth2?response_type=code&redirect_uri=https3A2F2Fclient2Eexample2Ecom2Fcb&client_id=foo&scope=email20stuff)

The authorization_uri , escaped_redirect_uri , escaped_client_id and escaped_scope parameters originate from the result of the the goa_oauth2_provider_get_authorization_uri(), goa_oauth2_provider_get_redirect_uri(), goa_oauth2_provider_get_client_id() and goa_oauth2_provider_get_scope() methods with the latter three escaped using g_uri_escape_string().

goa_oauth2_provider_add_account_key_values ()

void
goa_oauth2_provider_add_account_key_values
                               (GoaOAuth2Provider *provider,
                                GVariantBuilder *builder);

Hook for implementations to add key/value pairs to the key-file when creating an account.

This is a virtual method where the default implementation does nothing.

goa_oauth2_provider_get_identity_sync ()

gchar *
goa_oauth2_provider_get_identity_sync (GoaOAuth2Provider *provider,
                                       const gchar *access_token,
                                       gchar **out_presentation_identity,
                                       GCancellable *cancellable,
                                       GError **error);

Method that returns the identity corresponding to access_token .

The identity is needed because all authentication happens out of band. In addition to the identity, an implementation also returns a presentation identity that is more suitable for presentation (the identity could be a GUID for example).

The calling thread is blocked while the identity is obtained.

goa_oauth2_provider_get_access_token_sync ()

gchar *
goa_oauth2_provider_get_access_token_sync
                               (GoaOAuth2Provider *provider,
                                GoaObject *object,
                                gboolean force_refresh,
                                gint *out_access_token_expires_in,
                                GCancellable *cancellable,
                                GError **error);

Synchronously gets an access token for object . The calling thread is blocked while the operation is pending.

The resulting token is typically read from the local cache so most of the time only a local roundtrip to the storage for the token cache (e.g. gnome-keyring-daemon) is needed. However, the operation may involve refreshing the token with the service provider so a full network round-trip may be needed.

Note that multiple calls are serialized to avoid multiple outstanding requests to the service provider.

This operation may fail if e.g. unable to refresh the credentials or if network connectivity is not available. Note that even if a token is returned, the returned token isn't guaranteed to work - use goa_provider_ensure_credentials_sync() if you need stronger guarantees.

goa_oauth2_provider_process_redirect_url ()

gboolean
goa_oauth2_provider_process_redirect_url
                               (GoaOAuth2Provider *provider,
                                const gchar *redirect_url,
                                gchar **authorization_code,
                                GError **error);

Certain OAuth2-like, but not exactly OAuth2, providers do not follow the standard mechanisms for extracting the access token or auth code from the redirect URI. They use some non-standard technique to do so. This is a provider specific hook to accommodate them and will only be used if implemented.

This is a pure virtual method - a subclass must provide an implementation if needed.

GoaOAuth2Provider

typedef struct _GoaOAuth2Provider GoaOAuth2Provider;

The GoaOAuth2Provider structure contains only private data and should only be accessed using the provided API.

GoaOAuth2ProviderClass

typedef struct {
  GoaProviderClass parent_class;

  /* pure virtual */
  const gchar *(*get_authorization_uri)        (GoaOAuth2Provider            *provider);
  const gchar *(*get_redirect_uri)             (GoaOAuth2Provider            *provider);
  const gchar *(*get_client_id)                (GoaOAuth2Provider            *provider);
  const gchar *(*get_client_secret)            (GoaOAuth2Provider            *provider);
  gchar       *(*get_identity_sync)            (GoaOAuth2Provider            *provider,
                                                const gchar                  *access_token,
                                                gchar                       **out_presentation_identity,
                                                GCancellable                 *cancellable,
                                                GError                      **error);

  /* virtual but with default implementation */
  gchar       *(*build_authorization_uri)      (GoaOAuth2Provider            *provider,
                                                const gchar                  *authorization_uri,
                                                const gchar                  *escaped_redirect_uri,
                                                const gchar                  *escaped_client_id,
                                                const gchar                  *escaped_scope);
  const gchar *(*get_token_uri)                (GoaOAuth2Provider            *provider);
  const gchar *(*get_scope)                    (GoaOAuth2Provider            *provider);
  gboolean     (*get_use_mobile_browser)       (GoaOAuth2Provider            *provider);
  void         (*add_account_key_values)       (GoaOAuth2Provider            *provider,
                                                GVariantBuilder              *builder);

  /* pure virtual */
  gboolean     (*is_identity_node)             (GoaOAuth2Provider            *provider,
                                                WebKitDOMHTMLInputElement    *element);

  /* virtual but with default implementation */
  gboolean     (*is_deny_node)                 (GoaOAuth2Provider            *provider,
                                                WebKitDOMNode                *node);
  gboolean     (*is_password_node)             (GoaOAuth2Provider            *provider,
                                                WebKitDOMHTMLInputElement    *element);
  gboolean     (*decide_navigation_policy)     (GoaOAuth2Provider              *provider,
                                                WebKitWebView                  *web_view,
                                                WebKitNavigationPolicyDecision *decision);
  gboolean     (*process_redirect_url)         (GoaOAuth2Provider            *provider,
                                                const gchar                  *redirect_url,
                                                gchar                       **access_token,
                                                GError                      **error);
} GoaOAuth2ProviderClass;

Class structure for GoaOAuth2Provider.