This section defines various terms used in this documentation.

app-id

The App-Id is a form of recoverable password based on someone's physical world identification, such as a passport or government ID card. Get more information at https://github.com/DataVaccinator/APP-ID/blob/master/docs/appid_manual/appid-manual.adoc

cURL

cURL and libcurl is a free and easy-to-use client-side URL transfer library. Get more information at https://curl.se.

DataVaccinator

This term describes the overall use of the DataVaccinator Vault, a potential Service Provider and a DataVaccinator Client in order to protect sensitive PID data via pseudonymisation.

DataVaccinator Client

Software using this or another DataVaccinator client library to pseudonymise PID.

DataVaccinator Vault

The service that stores your PID data. Get more information at https://www.datavaccinator.com

index word

This is a term that is sent to the DataVaccinator Vault to index the associated PID data. It is there to be found by a search word using the dvSearch function. An index word is always made lowercase so that it essentially becomes caseless.

search word

This is a term that is used in dvSearch to retrieve VID entries whose PID was indexed using index word entries. A search word must be the start of an index word to find the assoiacted VID entry. A search word is always made lowercase so that it essentially becomes caseless.

Service Provider

The service provider is between the DataVaccinator Client and the DataVaccinator Vault. It receives all REST calls and forwards PID data to the DataVaccinator Vault and relays VID data back to the DataVaccinator Client. It may authenticate users and otherwise process VID data.

PID

PID stands for Personal Identifiers. See https://en.wikipedia.org/wiki/Personal_identifier

PKCS#7 Padding

See https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS#5_and_PKCS#7

SID

The Service Provider identifier. It is used with the SPW by the DataVaccinator Vault to authenticate a Service Provider or a DataVaccinator Client.

SPW

The Service Provider password. It is used with the SID by the DataVaccinator Vault to authenticate a Service Provider or a DataVaccinator Client.

VID

VID stands for Vaccination Identifier. It is an alias representing a piece of PID stored in the DataVaccinator Vault.

VID Map

This is an ruMap return by dvGet ,dvGetPublished and dvChangeAppId . Its key is is a VID entry. Its value usually consists of the associated PID and a status code. The value is retrieved using dvGetVid and should be copied to persist. This map must be freed with ruMapFree when no longer needed. The status code may be one of the following:

RUE_OK Everything is OK and the PID data is present. When the map came from dvChangeAppId these entries have data set to NULL.
RUE_FILE_NOT_FOUND The entry has not be found in the DataVaccinator Vault and data is NULL.
DVE_INVALID_CREDENTIALS The wrong app-id was used to decrypt. When the map came from dvChangeAppId the data contains the checksum of the encrypted entry, otherwise data is NULL.