Ctrlk
HomepageAPISDK
Edit

Attachments

Attaching a File to an Item

Every item in the meeco vault has the capability of having multiple files attached to it. The attachments are always attached to the item via a slot with the slot_type attachment. Assuming you have created an item already (such as the one you may have created in the getting-started page) and have the .item.config file still, lets create another item with that same config so as not to conflict with other steps later on in this guide.

meeco items:create -i .item-config.yaml -a .alice.yaml > .item2.yaml

the next step is to create an attachment-config.yaml file with the following content.

kind: FileAttachment
metadata:
  item_id: e8670e6c-8a95-43ff-a8d1-08805f612250 # (target item id from .item2.yaml)
spec:
  label: 'Secret test webm video'
  file: './test.webm'

Then run the cli command

meeco items:attach-file -c attachment-config.yaml -a .alice.yaml > .attach-response.yaml

You will get a response in the attach-response.yaml file that looks like the following

attachment:
  id: fe9ef5ad-b29c-4b71-bb73-b14fd4b88dca
  content_type: video/webm
  filename: test.webm
  ...
slots:
  - id: 67b2a8c2-4a4b-4a53-9b2f-5411cd63576b
    attachment_id: fe9ef5ad-b29c-4b71-bb73-b14fd4b88dca
    slot_type_name: attachment
    item_id: e8670e6c-8a95-43ff-a8d1-08805f612250
    label: My Secret File
    encrypted_value: Aes256Gcm.z-T6OnEB6ssmkQK4RcvtYHjh2rE5PregqflhZoVXq6w=.QUAAAAAFaXYADAAAAAAhvEHoJqo845AsORoFYXQAEAAAAACahlEdh5rJcKfnl0DtTiaBAmFkAAUAAABub25lAAA=
    ...
item:
  id: e8670e6c-8a95-43ff-a8d1-08805f612250
  label: Item Label
  slot_ids:
    - 67b2a8c2-4a4b-4a53-9b2f-5411cd63576b
  ...

Note: The slot's encrypted_value in this case is a new encryption key which has been encrypted with the user's own private data encryption key. The reason the file gets encrypted with a new data encryption key instead of directly with the user's existing private data encryption key has to do with sharing. By using this method when sharing, instead of having to re-encrypt the whole file with another data encryption key the slot's encrypted_value can simply be decrypted then re-encrypted with the data encryption key used for sharing.

Downloading the Attached File

To download an attached file the CLI needs to know the item's id and the slot's id, this is so the CLI can decrypt the data encryption key from the encrypted_value of the slot (as mentioned above). Both of these values can be found in the .attach-response.yaml file under slots[0].id and slots[0].item_id.

To download run the following

Sharing and receiving the attachment

Sharing an attachment simply works the same way you would share any other slot. First you will need to have a connection to another user, see the directions in the "Connections and Sharing" page to set up a connection first. Assuming you have a connection set up already and have the second user's info in a .bob.yaml file...

Run the command

To create the share config then to create the share itself

You should see some output like the following in the .create-shares-response.yaml file.

to see the incoming shared item first make a request for items as bob run

you will see something like the following as output

Notice how the share_id matches the share output from the previous command. We can then request the item itself.

Returning

Now we have all the information we need to be able to download the attached file

Using the file-storage-browser or file-storage-node Packages

The above flow is a great start to understanding how everything works however for actual product implementation these npm packages are likely to be more useful so please head to the following links and check out the README.md files there.

file-storage-browser https://github.com/Meeco/js-sdk/tree/releases/file-storage/latest/packages/file-storage-browser

file-storage-node https://github.com/Meeco/js-sdk/tree/releases/file-storage/latest/packages/file-storage-node

Last updated