AuthenticationManager-class: Manage DataONE authentication.

In dataone: R Interface to the DataONE REST API

Manage DataONE authentication.

Description

AuthenticationManager provides mechanisms to validate DataONE authentication, when either a DataONE authentication token or X.509 Certificate is used.

Details

Understanding how your identity is managed is important for working with DataONE, especially to avoid unexpected results. For example, depending your authorization status, searches may return only public records, or the full set of public and private records. Object and package retrievals might fail if some or all of the objects being retrieved are private. Creating or updating objects on DataONE nodes and reserving identifiers might fail if your authorization credentials are missing or expired.

DataONE version 1.0 identifies you using CILogon-provided x509 certificates. DataONE has partnered with CILogon to provide a widely-accessible certificate issuing mechanism that allows DataONE users to use existing trusted institutional and public accounts.

DataONE version 2.0 provides an addition authentication mechanism known as authentication tokens. For information about tokens and instructions for generating a token for use with the dataone R package, view the overview document by entering the command: 'vignette("dataone-overview")'. DataONE authentication tokens can be obtained by signing in to your DataONE account at https://search.dataone.org.

CILogon recognizes many identity providers, including many universities as well as Google, so most times users new to DataONE can get certificates using one of their existing accounts. For more information about the CILogon service, see https://cilogon.org/?skin=DataONE .

Slots

obscured

Value of type "character" Is authentication disabled (obscured)?

Methods

• AuthenticationManager: Create an AuthenticationManager object.

• isAuthValid: Verify authentication for a member node.

• getToken: Get the value of the DataONE Authentication Token, if one exists.

• getCert: Get the DataONE X.509 Certificate location.

• getAuthMethod: Get the current valid authentication mechanism.

• getAuthSubject: Get the authentication subject.

• getAuthExpires: Get the expiration date of the current authentication method.

• isAuthExpired: Check if the currently valid authentication method has reached the expiration time.

• obscureAuth: Temporarily disable DataONE authentication.

• restoreAuth: Restore authentication (after being disabled with obscureAuth).

• showAuth: Display all authentication information.

• getTokenInfo: Display all authentication token information.

• getCertInfo: Display all X.509 certificate information.

See Also

dataone package description.

dataone documentation built on June 11, 2022, 1:06 a.m.