[DRIVERS-752] Create language specific copy/pasteable FLE tutorials Created: 11/Sep/19  Updated: 24/Mar/22  Resolved: 16/Apr/21

Status: Closed
Project: Drivers
Component/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Bernie Hackett Assignee: Unassigned
Resolution: Done Votes: 0
Labels: fle-ga
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on CDRIVER-3402 Create language specific copy/pasteab... Closed
depends on CSHARP-2810 Create language specific copy/pasteab... Closed
depends on CXX-1855 Create language specific copy/pasteab... Closed
depends on GODRIVER-1368 Create language specific copy/pasteab... Closed
depends on JAVA-3477 Create language specific copy/pasteab... Closed
depends on MOTOR-436 Create language specific copy/pasteab... Closed
depends on NODE-2265 Create language specific copy/pasteab... Closed
depends on PHPLIB-492 Create language specific copy/pasteab... Closed
depends on RUBY-1974 Create language specific copy/pasteab... Closed
Related
related to DRIVERS-782 Update FLE documentation for communit... Closed
is related to PYTHON-1993 Add documentation examples for client... Closed
Driver Compliance:
Key Status/Resolution FixVersion
CSHARP-2810 Duplicate
CDRIVER-3402 Fixed 1.16.0
NODE-2265 Fixed 3.4.0
CXX-1855 Fixed 3.7.0, 3.7.0-beta1
PHPLIB-492 Fixed 1.6.0
MOTOR-436 Done
RUBY-1974 Fixed 2.12.0.rc0
GODRIVER-1368 Fixed 1.2.0
JAVA-3477 Done

 Description   

Feedback from the FLE Beta. From kenneth.white:

The basics are a language-canonical/recommended way to: create a kms key and a local key (with fake AWS creds/fake base64 hex string); create an FLE mongo client with a local json schema referencing a data key (ideally through a reference to a prior keyvault query/method call); insert a record with an encrypted field explicitly and implicitly; query a record by an encrypted field. Bonus is a language specific way to create a server side json schema with 'encrypt'. Even single record operations are fine.

Each driver should port the Java tutorial to their FLE documentation.



 Comments   
Comment by Kevin Albertson [ 16/Oct/19 ]

Updated description, moving to DRIVERS. ravind.kumar, after drivers have added examples we'll need to update this docs page with other language tabs.

Comment by Jeffrey Yemin [ 07/Oct/19 ]

Move to DRIVERS, say in description to use Java driver reference doc as a template

Comment by Kenneth White [ 07/Oct/19 ]

For Node, there are lots of examples here: https://www.npmjs.com/package/mongodb-client-encryption#AutoEncrypter

but this class is marked "An internal class to be used by the driver for auto encryption NOTE: Not meant to be instantiated directly, this is for internal use only."

Comment by Bernie Hackett [ 27/Sep/19 ]

I don't think so. It will get done faster if the language developers write the examples.

Comment by Kevin Albertson [ 27/Sep/19 ]

Ping behackett. Should we move this to DOCSP?

Comment by Kevin Albertson [ 20/Sep/19 ]

behackett do you think this should be part of the spec or should this be a DOCSP ticket?

Generated at Thu Feb 08 08:22:17 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.