Skip to content
/ tackd Public

Tackd is an encrypted message relay, which enables parties to anonymously and security transmit and receive data via a RESTful API.

2 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

findelabs/tackd

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

237 Commits
.github/workflows
.github/workflows
 
 
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
Cargo.lock
Cargo.lock
 
 
Cargo.toml
Cargo.toml
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 

Repository files navigation

Tackd

What is Tackd

Tackd is an encrypted message relay, which enables parties to anonymously and security transmit and receive data via a RESTful API.

Tackd encrypts payloads with the XChaCha20Poly1305 stream cipher upon receipt. Indexing data is then persisted in the backing MongoDB database, with the encrypted data stored in Cloud Storage. The encryption key is returned to the original sender, with the key not persisted by Tackd. Data retrieval is possible by any client with the required decryption key, as well as optional password, if it was provided when data was uploaded.

By default, Tackd will persisted messages for one hour, or a single retrieval, whichever comes first. These settings can be overridden be the sender.

Tackd API

Base URL

All API calls should be directed to either a locally running instance, or to the public https://tackd.io server.

Getting Started

  1. Create user account
curl https://tackd.io/api/v1/user \
-d '{"email":"[email protected]","pwd":"mypassword"}' \
-H 'content-type: application/json'
  1. Generate API key
curl -u {{ user id }}:mypassword https://tackd.io/api/v1/user/apiKeys?role=admin -XPOST
  1. List API keys.
curl -u {{ api key }}:{{ api secret }} https://tackd.io/api/v1/user/apiKeys
  1. Upload string of data
curl -u {{ api key }}:{{ api secret }} https://tackd.io/upload?expires=1d\&tags=key:value \
--data-binary "This is my payload"

Upload

Upload a file to Tackd.io.

POST /upload

Query Parameters

Attribute Type Requirement Notes
expires int/string optional Set data expiration time in seconds, or s, m, h, d, w, y
reads int optional Set maximum number of reads for data
pwd string optional Lock data with additional password
filename string optional Specify filename for upload
tags string optional Comma separated tags

Response Codes

Type Code Notes
Success 200 Returns json object
Error 500 Internal server error

Sample Response

{
  "message": "Saved",
  "url": "https://tackd.io/download/d2e1152b-ef91-4e4a-834c-62c41a4278e9?key=ldR9aQY5pBZThQtgsvb0YqK9xmerCBN0",
  "data": {
    "id": "d2e1152b-ef91-4e4a-834c-62c41a4278e9",
    "key": "ldR9aQY5pBZThQtgsvb0YqK9xmerCBN0",
    "expires in": 3600,
    "max reads": 1
  }
}

File Retrieval

Download a file from Tackd.io.

GET /download/{id}

Path Parameters

Attribute Type Requirement Notes
id string required Specify data id or file to download

Query Parameters

Attribute Type Requirement Notes
id string optional ID to get, use if filename is passed in path
key string required Decryption key
pwd string optional Unlock data with password

Response Codes

Type Code Notes
Success 200 Returns binary data
Error 404 Not Found
Error 500 Internal server error

Register New User

Register a new email with Tackd.io.

POST /api/v1/user

Payload Parameters (JSON)

Field Type Notes
email String User's email
pwd String User's password

Response Codes

Type Code Notes
Success 200 Success
Error 409 Email already exists
Error 500 Internal server error

Sample Payload

{
  "email": "[email protected]",
  "pwd": "mypassword"
}

Sample Response

{
  "created": true,
  "user id": "37a8a05b-742d-4306-bdd8-9e7c4236d42b"
}

Recover User ID

Recover UUID for email from Tackd.io.

POST /api/v1/user/recover/id

Payload Parameters (JSON)

Field Type Notes
email String User's email
pwd String User's password

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Payload

{
  "email": "[email protected]",
  "pwd": "mypassword"
}

Sample Response

{
  "email": "[email protected]",
  "user id": "4424e943-64c8-4098-921c-93443815d32e"
}

Create New API Key

Create new API key for user.

POST /api/v1/user/apiKeys

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Query Parameters

Attribute Type Requirement Notes
tags string optional Comma separated tags
role string optional admin or upload, defaults to upload

Response Codes

Type Code Notes
Success 200 Success
Error 401 Not Found
Error 500 Internal server error

Sample Response

{
  "created": true,
  "data": {
    "key": "CzsIzBHz",
    "secret": "00d757a55081cc58896c",
    "created": "2022-11-28T00:33:24.366572901Z",
    "access": {
      "role": "upload"
    }
  }
}

List API Keys

List API keys for user.

GET /api/v1/user/apiKeys

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  {
    "key": "CzsIzBHz",
    "created": "2022-11-28T00:33:24.366572901Z",
    "access": {
      "role": "admin"
    }
  }
]

Delete API Key

Delete user's API key.

DELETE /api/v1/user/apiKeys/{key}

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
key string required Specify API key

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

{
  "delete": true
}

List Uploads

List user's uploads.

GET /api/v1/uploads

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Query Parameters

Attribute Type Requirement Notes
tags string optional Filter by tags, comma seperated

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  {
    "id": "436bdf7f-6d6e-4d26-8177-364ee5c61dca",
    "meta": {
      "created": "2022-12-06T02:07:57.168752Z",
      "content_type": "application/x-www-form-urlencoded",
      "user_agent": "curl/7.84.0",
      "bytes": 44
    },
    "lifecycle": {
      "max": {
        "reads": -1,
        "seconds": 3600,
        "expires": 1670296077
      },
      "current": {
        "reads": 7
      }
    },
    "links": [
      {
        "id": "95345270-5dfe-4d98-aae0-db6ffc73e21d",
        "created": "2022-12-06T02:07:57.168750Z",
        "reads": 2
      },
      {
        "id": "d44b0655-b8db-4706-ad8b-8186e18f8604",
        "created": "2022-12-06T02:08:30.307616Z",
        "reads": 5
      }
    ]
  }
]

Get Upload Info

Get single user upload info.

GET /api/v1/uploads/{id}

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  {
    "id": "436bdf7f-6d6e-4d26-8177-364ee5c61dca",
    "meta": {
      "created": "2022-12-06T02:07:57.168752Z",
      "content_type": "application/x-www-form-urlencoded",
      "user_agent": "curl/7.84.0",
      "bytes": 44
    },
    "lifecycle": {
      "max": {
        "reads": -1,
        "seconds": 3600,
        "expires": 1670296077
      },
      "current": {
        "reads": 2
      }
    },
    "links": [
      {
        "id": "95345270-5dfe-4d98-aae0-db6ffc73e21d",
        "created": "2022-12-06T02:07:57.168750Z",
        "reads": 2
      }
    ]
  }
]

Delete Upload

Delete single user upload.

DELETE /api/v1/uploads/{id}

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

{
  "deleted": true
}

List Upload Links

List upload links.

GET /api/v1/uploads/{id}/links

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  {
    "id": "9aa8de6b-8b4f-492c-b8b7-cd6356387a3f",
    "created": "2022-12-03T03:06:35.260646162Z"
  }
]

Create new upload Link

Create new upload link.

PUT /api/v1/uploads/{id}/links

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Query Parameters

Attribute Type Requirement Notes
tags string optional Comma separated tags

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

{
  "created": true,
  "url": "https://tackd.io/download/a1ef26eb-ae9e-4793-855b-ebb00aba048f?key=D1i03EFoDvT15HZNtOCdb03rnBqo5TvQ",
  "data": {
    "id": "a1ef26eb-ae9e-4793-855b-ebb00aba048f",
    "key": "D1i03EFoDvT15HZNtOCdb03rnBqo5TvQ",
    "created": "2022-12-03T15:06:51.003586994Z"
  }
}

Delete upload Link

Create new upload link.

DELETE /api/v1/uploads/{id}/links/{link}

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id
link string required Specify link id

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

{
  "deleted": true
}

Get tags to existing upload

Get tags for uploaded data.

GET /api/v1/uploads/{id}/tags

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Query Parameters

Attribute Type Requirement Notes
tags string optional Comma separated tags

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  "type:pptx",
  "modified:true"
]

Add tags to existing upload

Create new tag or tags for uploaded data.

PUT /api/v1/uploads/{id}/tags

Authentication

Type User Notes
Basic UUID Unique User ID
Basic API Key API Key/Secret

Path Parameters

Attribute Type Requirement Notes
id string required Specify upload id

Query Parameters

Attribute Type Requirement Notes
tags string optional Comma separated tags

Response Codes

Type Code Notes
Success 200 Success
Error 401 Unauthorized
Error 500 Internal server error

Sample Response

[
  "newtag:value"
]

Limits

  • Data max age is currently capped at seven years
  • Default retention duration is one month
  • Payloads are only accepted up to 200MB

About

Tackd is an encrypted message relay, which enables parties to anonymously and security transmit and receive data via a RESTful API.

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

82 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages