@cumulus/launchpad-auth
Advanced tools
Utilities for authentication by Cumulus using Launchpad.
npm install @cumulus/launchpad-auth
Utility functions for generating and validating Launchpad tokens
A class for sending requests to Launchpad token service endpoints
Utility functions for generating and validating Launchpad tokens
Promise.<string> ⏏Promise.<ValidateTokenResult> ⏏Promise.<string> ⏏Get a Launchpad token
Kind: Exported function
Returns: Promise.<string> - - the Launchpad token
| Param | Type | Description |
|---|---|---|
| params | Object | the configuration parameters for creating LaunchpadToken object |
| params.api | string | the Launchpad token service api endpoint |
| params.passphrase | string | the passphrase of the Launchpad PKI certificate |
| params.certificate | string | the name of the Launchpad PKI pfx certificate |
Promise.<ValidateTokenResult> ⏏Validate a Launchpad token
Kind: Exported function
Returns: Promise.<ValidateTokenResult> - - the validate result object with
{ status: 'success or failed', message: 'reason for failure',
session_maxtimeout: number second, session_starttime: number millisecond,
owner_auid: string}
| Param | Type | Description |
|---|---|---|
| params | Object | the configuration parameters for creating LaunchpadToken object |
| params.api | string | the Launchpad token service api endpoint |
| params.passphrase | string | the passphrase of the Launchpad PKI certificate |
| params.certificate | string | the name of the Launchpad PKI pfx certificate |
| token | string | the token to be validated |
| [userGroup] | string | the cumulus user group that a valid user should belong to |
A class for sending requests to Launchpad token service endpoints
Kind: global class
Promise.<Object>Promise.<Object>| Param | Type | Description |
|---|---|---|
| params | Object | |
| params.api | string | the Launchpad token service api endpoint |
| params.passphrase | string | the passphrase of the Launchpad PKI certificate |
| params.certificate | string | the name of the Launchpad PKI pfx certificate |
Example
const LaunchpadToken = require('@cumulus/launchpad-auth/LaunchpadToken');
const launchpadToken = new LaunchpadToken({
api: 'launchpad-token-api-endpoint',
passphrase: 'my-pki-passphrase',
certificate: 'my-pki-certificate.pfx'
});
Promise.<Object>Get a token from Launchpad
Kind: instance method of LaunchpadToken
Returns: Promise.<Object> - - the Launchpad gettoken response object
Promise.<Object>Validate a Launchpad token
Kind: instance method of LaunchpadToken
Returns: Promise.<Object> - - the Launchpad validate token response object
| Param | Type | Description |
|---|---|---|
| token | string | the Launchpad token for validation |
Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.
To make a contribution, please see our contributing guidelines.
Generated automatically using npm run build-docs
[v9.7.0] 2021-10-01
queue-granules task now updates granule status to queued when a granule is queued. In order to prevent issues with the private API endpoint and Lambda API request and concurrency limits, this functionality runs with limited concurrency, which may increase the task's overall runtime when large numbers of granules are being queued. If you are facing Lambda timeout errors with this task, we recommend converting your queue-granules task to an ECS activity. This concurrency is configurable via the task config's concurrency value.discover-granules task has been updated to limit concurrency on checks to identify and skip already ingested granules in order to prevent issues with the private API endpoint and Lambda API request and concurrency limits. This may increase the task's overall runtime when large numbers of granules are discovered. If you are facing Lambda timeout errors with this task, we recommend converting your discover-granules task to an ECS activity. This concurrency is configurable via the task config's concurrency value.<prefix>-sfEventSqsToDbRecords Lambda to 1024MB@cumulus/queue-granules to respect a new config parameter: preferredQueueBatchSize. Queue-granules will respect this batchsize as best as it can to batch granules into workflow payloads. As workflows generally rely on information such as collection and provider expected to be shared across all granules in a workflow, queue-granules will break batches up by collection, as well as provider if there is a provider field on the granule. This may result in batches that are smaller than the preferred size, but never larger ones. The default value is 1, which preserves current behavior of queueing 1 granule per workflow.DiscoverGranulesToThrottledQueue that discovers and writes
granules to a throttled background queue. This allows discovery and ingest
of larger numbers of granules without running into limits with lambda
concurrency.archive_api_reserved_concurrency from 8 to 5 to use fewer reserved lambda
functions. If you see throttling errors on the <stack>-apiEndpoints you
should increase this value.archive_api_reserved_concurrency from 8 to 15 to prevent throttling on
the dashboard for default deployments.api/endpoints/execution-status.js get method to include associated granules, as
an array, for the provided execution.getExecutionArnsByGranuleCumulusId returning a list of executionArns sorted by most recent first,
for an input Granule Cumulus ID in support of the move of translatePostgresGranuleToApiGranule from RDS-Phase2
feature branchgetApiExecutionCumulusIds returning cumulus IDs for a given list of executionseraseDynamoTables(). Changed the call Promise.all() to Promise.allSettled() to ensure all dynamo records (provider records in particular) are deleted prior to reseeding.FAQs
Utilities for authentication with Launchpad
The npm package @cumulus/launchpad-auth receives a total of 92 weekly downloads. As such, @cumulus/launchpad-auth popularity was classified as not popular.
We found that @cumulus/launchpad-auth demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.