שיטה: wrap

הפונקציה מחזירה מפתח מוצפן להצפנת נתונים (DEK) ונתונים משויכים.

פרטים נוספים זמינים במאמר הצפנה ופענוח של נתונים.

בקשת HTTP

POST https://KACLS_URL/wrap

מחליפים את KACLS_URL בכתובת ה-URL של שירות רשימת המפתחות של בקרת הגישה (KACLS).

פרמטרים של נתיב

ללא.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "authentication": string,
  "authorization": string,
  "key": string,
  "reason": string
}
שדות
authentication

string

‫JWT שהונפק על ידי ספק הזהויות וכולל הצהרה לגבי זהות המשתמש. ראו אסימוני אימות.
authorization

string

‫JWT שמאשר שהמשתמש מורשה להצפין מפתח עבור resource_name. מידע על טוקנים של הרשאה
key

string

מפתח ה-DEK בקידוד Base64. גודל מקסימלי: 128 בייטים.
reason

string (UTF-8)

מחרוזת JSON להעברה שמספקת הקשר נוסף לגבי הפעולה. צריך לבצע סניטציה ל-JSON שסופק לפני שמציגים אותו. גודל מקסימלי: 1KB.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה אובייקט בינארי אטום שייאוחסן על ידי Google Workspace לצד האובייקט המוצפן, ויישלח כמו שהוא בכל פעולה עתידית של ביטול הצפנה של המפתח.

אם הפעולה נכשלת, צריך להחזיר תשובה עם שגיאה מובנית.

האובייקט הבינארי צריך להכיל את העותק היחיד של ה-DEK המוצפן, ואפשר לאחסן בו נתונים ספציפיים להטמעה.

לא לאחסן את ה-DEK במערכת של שירות רשימת המפתחות של בקרת הגישה (KACLS), אלא להצפין אותו ולהחזיר אותו באובייקט wrapped_key. כך נמנעים הבדלים בין המסמך לבין המפתחות שלו לאורך זמן. לדוגמה, כדי לוודא שהנתונים של המשתמש נמחקים לגמרי כשהוא מבקש זאת, או כדי לוודא שאפשר לפענח גרסאות קודמות ששוחזרו מגיבוי.

ייצוג ב-JSON 
{
  "wrapped_key": string
}
שדות
wrapped_key

string

האובייקט הבינארי בקידוד Base64. גודל מקסימלי: 1KB.

דוגמה

בדוגמה הזו מופיעות בקשה ותשובה לדוגמה של שיטת wrap.

בקשה

POST https://mykacls.example.com/v1/wrap

{
   "key":"wHrlNOTI9mU6PBdqiq7EQA==",
   "authorization": "eyJhbGciOi…"
   "authentication": "eyJhbGciOi…"
   "reason": "{client:'drive' op:'update'}"
}

תשובה

{
    "wrapped_key": "3qTh6Mp+svPwYPlnZMyuj8WHTrM59wl/UI50jo61Qt/QubZ9tfsUc1sD62xdg3zgxC9quV4r+y7AkbfIDhbmxGqP64pWbZgFzOkP0JcSn+1xm/CB2E5IknKsAbwbYREGpiHM3nzZu+eLnvlfbzvTnJuJwBpLoPYQcnPvcgm+5gU1j1BjUaNKS/uDn7VbVm7hjbKA3wkniORC2TU2MiHElutnfrEVZ8wQfrCEpuWkOXs98H8QxUK4pBM2ea1xxGj7vREAZZg1x/Ci/E77gHxymnZ/ekhUIih6Pwu75jf+dvKcMnpmdLpwAVlE1G4dNginhFVyV/199llf9jmHasQQuaMFzQ9UMWGjA1Hg2KsaD9e3EL74A5fLkKc2EEmBD5v/aP+1RRZ3ISbTOXvxqYIFCdSFSCfPbUhkc9I2nHS0obEH7Q7KiuagoDqV0cTNXWfCGJ1DtIlGQ9IA6mPDAjX8Lg=="
}