Commit 61ac4c3d authored by ethiraj krishnamanaidu's avatar ethiraj krishnamanaidu
Browse files

Initial Import

parents
root = true
[*]
charset = utf-8
end_of_line = lf
tab_width = 2
indent_style = space
indent_size = 2
max_line_length = 100
insert_final_newline = true
trim_trailing_whitespace = true
ij_continuation_indent_size=4
### IntelliJ IDEA ###
.idea/
*.iws
*.iml
*.ipr
out/
### Java ###
# Compiled class file
*.class
# Log file
*.log
# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar
### Maven ###
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
.mvn/wrapper/maven-wrapper.jar
.flattened-pom.xml
### VisualStudioCode ###
.vscode/
### macOS ###
# General
.DS_Store
\ No newline at end of file
# Use the official maven/java 8 image to create a build artifact.
# http://hub.docker.com/_/maven
FROM maven:3-jdk-8-alpine AS builder
# Copy local code to container image.
## Create all the needed folders
WORKDIR /app
COPY pom.xml .
COPY .m2/ .m2/
COPY file-core/ file-core/
COPY provider/ provider/
# Build a release artifact for the child project
RUN mvn -T2 package -DskipTests -B -s .m2/settings.xml
# Use the official AdoptOpenJDK for a base image.
# https://hub.docker.com/_/openjdk
FROM openjdk:8-slim
WORKDIR /app
ARG PROVIDER_NAME
ENV PROVIDER_NAME $PROVIDER_NAME
# Copy the jar to the production image from the builder stage.
COPY --from=builder /app/provider/file-${PROVIDER_NAME}/target/file-${PROVIDER_NAME}-*.jar file-${PROVIDER_NAME}.jar
# Run the web service on container startup.
CMD java -Djava.security.egd=file:/dev/./urandom -Dserver.port=${PORT} -jar /app/file-${PROVIDER_NAME}.jar
# Use the official AdoptOpenJDK for a base image.
# https://hub.docker.com/_/openjdk
FROM openjdk:8-slim
WORKDIR /app
ARG PROVIDER_NAME
ENV PROVIDER_NAME $PROVIDER_NAME
# Copy the jar to the production image from the builder stage.
COPY provider/file-${PROVIDER_NAME}/target/file-${PROVIDER_NAME}-*.jar file-${PROVIDER_NAME}.jar
# Run the web service on container startup.
CMD java -Djava.security.egd=file:/dev/./urandom -Dserver.port=${PORT} -jar /app/file-${PROVIDER_NAME}.jar
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# OSDU R2 Prototype File service
## Contents
* [Introduction](#introduction)
* [System interactions](#system-interactions)
* [Validations](#validations)
* [File API](#file-api)
* [POST /getLocation](#post-getlocation)
* [POST /getFileLocation](#post-getfilelocation)
* [POST /getFileList](#post-getfilelist)
* [Service Provider Interfaces](#service-provider-interfaces)
* [GCP implementation](#gcp-implementation)
* [Datastore](#datastore)
* [Firestore](#firestore-collections)
## Introduction
The OSDU R2 File service provides internal and external API endpoints to let the application or
user fetch any records from the system or request file location data. For example, users can
request generation of an individual signed URL per file. Using a signed URL, OSDU R2 users will be
able to upload their files to the system.
The current implementation of the File service supports only cloud platform-specific locations.
The future implementations might allow the use of on-premises locations.
## System interactions
The File service defines the following workflows:
* File upload
* File location
* File list
### File upload
The file upload workflow is defined for the `/getLocation` API endpoint. The following diagram
illustrates the workflow.
![OSDU R2 File Service getLocation](img/76421952-233e5100-63ad-11ea-8893-3ad5b6950b4c.png)
Upon a request to get a location for a file:
1. Verify the incoming request.
* Verify the authentication token. Fail signed URL generation if the token is missing or
invalid, and then respond with the `401 Unauthorized` status.
* Verify the partition ID. Fail signed URL generation if the partition ID is missing, invalid or
doesn't have assigned user groups, and then respond with the `400 Bad Request` status.
* Verify the file ID if it's passed in the request body. Fail signed URL generation if the file
ID is invalid or if this ID has already been created. Respond with `400 Bad Request` status
and the `Location for fileID {ID} already exists` message.
2. Generate a new Universally Unique Identifier (UUID) for the file if a file ID wasn't provided.
3. Create an empty object in storage, and then generate a signed URL with the write access for that
object. By the signed URL, the user or application will upload their file for ingestion. The
generated signed URL has a maximum duration of 7 days.
* By the signed URL, the user or application will upload their file.
* The generated signed URL has the maximum duration of 7 days.
> How signed URLs are generated depends on the cloud platform.
4. Create a record with file data in the database. The record will contain a key-value pair with the
file ID as the key and object as the value. For more information on the record, consult the
[Firestore](#firestore-collections) section.
5. Return the signed URL and file ID to the application or user.
### File location
The file location workflow is defined for the `/getFileLocation` API endpoint. The
following diagram demonstrates the workflow.
![OSDU R2 File Service getFileLocation](img/76414998-11ef4780-63a1-11ea-8a38-cb4dc4522d83.png)
Upon request from an OSDU R2 service:
1. Validate the incoming request.
* Verify the authentication token. Fail file location if the token is missing or
invalid, and then respond with the `401 Unauthorized` status.
* Verify the partition ID. Fail file location if the partition ID is missing, invalid
or doesn't have assigned user groups, and then respond with the `400 Bad Request` status.
2. Query the database with the `FileID` to get the file record.
3. Return the `Location` and `Driver` from the file record to the calling service.
### File list
The file list workflow is defined for the `/getFileList` API endpoint.
Upon request from another OSDU R2 service:
1. Verify the incoming request.
* Verify the authentication token. Fail file list if the token is missing or invalid,
and then respond with the `401 Unauthorized` status.
* Verify the partition ID. Fail file list if the partition ID is missing, invalid or
doesn't have assigned user groups, and then respond with the `400 Bad Request` status.
* Validate the file list request.
2. Obtain the requested files from the database.
3. Return the result to the caller.
## Database interactions
During each workflow, the File service queries the database. For more information about the file
records in the database, consult the [file-locations collection](#firestore-collections) section.
## Validations
The File service's current implementation performs a general check of the validity of the
authorization token and partition ID before the service starts generation of a location.
However, the File service in the OSDU R2 Prototype doesn't perform any verification whether a
file upload happened or whether the user started ingestion after uploading a file. In future OSDU
implementations, the File service will be able to check if file uploads did happen.
## File API
The File service's API includes the following three methods in the OSDU R2 Prototype:
* `/getLocation`, external
* `/getFileLocation`, internal
* `/getFileList`, internal
General considerations related to querying the File API:
* Each endpoint must receive the authentication bearer token in the "Authorization" header. Example:
`"Authorization": "Bearer {token}"`
* Each endpoint must receive a partition ID in header. Example:
`"Data-Partition-Id": "default-partition"`
* The request and response Content Type is **application/json**
### POST /getLocation
The `/getLocation` API endpoint creates a new location in the landing zone, such as a GCS bucket,
and returns it to the user so they upload a file for ingestion by that location.
#### Request body
| Property | Type | Description |
| ------------- | -------- | --------------------- |
| FileID | `String` | Unique ID of the file |
> **Note**: If a `FileID` isn't provided in the request, the File service generates a
> Universally Unique Identifier (UUID) to be stored in `FileID`. If a `FileID` is provided and is
> already registered in the system, an error is returned.
> **Note**: The `FileID` must correspond to the regular expression: `^[\w,\s-]+(\.\w+)?$`.
Request example:
```sh
curl --location --request POST 'https://{path}/getLocation' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'Data-Partition-Id: {Data-Partition ID}' \
--data-raw '{
"FileID": "8900a83f-18c6-4b1d-8f38-309a208779cc"
}'
```
#### Response
The File service returns the following data.
| Property | Type | Description |
| --------- | -------- | ----------------------------------------------------- |
| FileID | `String` | ID of the file to be ingested |
| Location | `List` | List of key-value pairs with cloud provider details to access the landing zone* |
| SignedURL | `String` | Signed URL by which the file to be ingested is stored |
> **Note**: The landing zone is a location in a cloud provider's platform where the user uploaded
> files for OSDU ingestion. The landing zone consists of the `Driver` and `Location` properties,
> which are stored in the database for each file upload request.
Response example:
```json
{
"FileID": "file ID",
"Location": {
"SignedURL": "GCS signed URL"
}
}
```
### POST /getFileLocation
The `/getFileLocation` API endpoint works similarly to `/getLocation`, but is internal and returns
the landing zone — `Location` and `Driver` — of a particular file instead of a signed
URL.
Once the OSDU security model is formulated and approved, the `/getFileLocation` API endpoint will
not be returning files that belong to other users.
#### Request body
| Property | Type | Description |
| -------- | -------- | ----------------------------- |
| FileID | `String` | ID of the file to be ingested |
Request example:
```sh
curl --location --request POST 'https://{path}/getFileLocation' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'Data-Partition-Id: {assigned partition ID}' \
--data-raw '{
"FileID": "8900a83f-18c6-4b1d-8f38-309a208779cc"
}'
```
#### Response
| Property | Type | Description |
| -------- | -------- | --------------------------------------------------- |
| Driver | `String` | Description of the storage where the file is stored |
| Location | `String` | Direct URI to the file in storage |
### POST /getFileList
The `/getFileList` API endpoint allows auditing the attempted file uploads. The method is
unavailable for third-party applications.
The ingestion process depends on whether the client application uploaded a file or not. The
`/getFileList` endpoint is designed to let other OSDU services to inspect which user uploaded a
file, whether the file was uploaded to the landing zone, and whether the user started ingestion
after the file upload.
#### Request
| Property | Type | Description |
| -------- | ---------- | ------------------------------------------- |
| TimeFrom | `datetime` | Timestamp |
| TimeTo | `datetime` | Time interval for the CreatedAd filter |
| PageNum | `integer` | The page number to return paginated results |
| Items | `short` | Pagination of the result |
| UserID | `String` | The ID of the user role or group |
> **Note**: The `UserID` property isn't supported in the OSDU R2 Prototype.
Request example:
```sh
curl --location --request POST 'https://{path}/getFileList' \
--header 'Authorization: Bearer {token}' \
--header 'Data-Partition-Id: {assigned partition ID}' \
--header 'Content-Type: application/json' \
--data-raw '{
"PageNum": 0,
"TimeFrom": "2020-01-01T16:21:00.552Z",
"UserID": "common-user",
"TimeTo": "2020-02-15T16:28:44.220Z",
"Items": 2
}'
```
### Response
A paginated result of the records stored in the database.
| Property | Type | Description |
| ---------------- | --------- | ------------------------------------------------ |
| Content | `List` | List of file records retrieved from the database |
| Number | `integer` | Some number |
| NumberOfElements | `integer` | The amount of the returned records |
| Size | `short` | The size of the Content list |
Each file record contains the following properties: `FileID`, `Driver`, `Location`, `CreatedAt`,
`CreatedBy`. For more information the returned properties, consult the [Firestore
collections](#firestore-collections) section.
Response example:
```json
{
"Content": [
{
"FileID": "30a1ace6-1c8f-4f08-9982-2e9c5df8e878",
"Driver": "GCS",
"Location": "gs://osdu-temporary-files/common-user/1580461525198-2020-02-12-05-23-25-198/30a1ace6-1c8f-4f08-9982-2e9c5df8e878",
"CreatedAt": "2020-02-12T05:24:25.198+0000",
"CreatedBy": "common-user"
},
{
"FileID": "da057da3-0fdb-41e4-afdc-3b63b812d484",
"Driver": "GCS",
"Location": "gs://osdu-temporary-files/common-user/1580461525198-2020-02-13-12-19-14-205/da057da3-0fdb-41e4-afdc-3b63b812d484",
"CreatedAt": "2020-02-13T12:19:14.205+0000",
"CreatedBy": "common-user"
}
],
"Number": 0,
"NumberOfElements": 2,
"Size": 2
}
```
## Service Provider Interfaces
The File service has several Service Provider Interfaces that the classes need to implement.
| Interface | Required/Optional | Path |
| ---------------------- | ----------------------- | ------------------------------------------------------------------------ |
| AuthenticationService | Optional to implement | `file-core/src/main/java/.../provider/interfaces/AuthenticationService` |
| FileListService | Optional to implement | `file-core/src/main/java/.../provider/interfaces/FileListService` |
| FileLocationRepository | Optional to implement | `file-core/src/main/java/.../provider/interfaces/FileLocationRepository` |
| FileService | Optional to implement | `file-core/src/main/java/.../provider/interfaces/FileService` |
| LocationMapper | Obligatory to implement | `file-core/src/main/java/.../provider/interfaces/LocationMapper` |
| LocationService | Optional to implement | `file-core/src/main/java/.../provider/interfaces/LocationService` |
| StorageRepository | Obligatory to implement | `file-core/src/main/java/.../provider/interfaces/StorageRepository` |
| StorageService | Obligatory to implement | `file-core/src/main/java/.../provider/interfaces/StorageService` |
| ValidationService | Optional to implement | `file-core/src/main/java/.../provider/interfaces/ValidationService` |
## GCP implementation
The GCP Identity and Access Management service account for the File service must have the
`iam.serviceAccounts.signBlob` permission.
The predefined **Cloud Functions Service Agent**, **Cloud Run Service Agent**, and **Service Account
Token Creator** roles include the required permission.
For development purposes, it's recommended to create a separate service account.
It's enough to grant the **Service Account Token Creator** role to the development service account.
Obtaining user credentials for Application Default Credentials isn't suitable in this case because
signing a blob is only available with the service account credentials. Remember to set the
`GOOGLE_APPLICATION_CREDENTIALS` environment variable. Follow the [instructions on the Google
developer's portal][application-default-credentials].
### Persistence layer
The GCP implementation contains two mutually exclusive modules to work with the persistence layer.
Presently, OSDU R2 connects to legacy Cloud Datastore for compatibility with the current OpenDES
implementation. In the future OSDU releases, Cloud Datastore will be replaced by a Cloud Firestore
implementation that's already available in the project.
* The Cloud Datastore implementation is located in the **provider/file-gcp-datastore** folder.
* The Cloud Firestore implementation is located in the **provider/file-gcp** folder.
To learn more about available collections, follow to the [Firestore collections](#firestore-collections)
section.
## Datastore
The service account for File service must have the `datastore.indexes.*` permissions. The
predefined **roles/datastore.indexAdmin** and **roles/datastore.owner** roles include the required
permission.
## Firestore collections
The GCP implementation of the File service uses Cloud Firestore with the following collections
and indexes.
### `file-locations` collection
| Field | Type | Description |
| --------- | -------- | ------------------------------------------------------------------------- |