IQSS / IQSS/dataverse

Signed URLs with parameters

Open
#11,062 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

External tools now work with signed urls. But as it is presently implemented it limits the use of Dataverse APIs by external tool, for example, use of apis with parameters. At present, the only parameters that are allowed are those declared in manifest json in queryParameters such as fileid, datasetid, etc. But sometimes the tool needs input from a user to use a proper api, for example it needs data for a specific variable selected by the user, for example http://localhost:8080/api/access/datafile/22/?format=subset&variables=v178 where v178 is a parameter selected by the user. We used this type of API for Data Curation Tool. Currently this api cannot be used by external tool. It would be nice to have a mechanism that would support parameters for signed urls.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how signed URLs validate parameters and how manifest JSON queryParameters are handled. Reproduce the example API request with a user-selected variables parameter, then define and test a mechanism that permits supported user-supplied parameters without weakening URL signing.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.