Skip to content

Commit 36988ba

Browse files
authored
docs(upgrade): add documentation of new encryption-configuration for osp #279
2 parents b751629 + 59abc87 commit 36988ba

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md

+68
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,74 @@ Each section includes the respective change details, impact on existing data and
3232

3333
> **_INFO:_** inside the detailed descriptions below, the definition 'migration script' refers to the term 'migrations' as it is defined by the ef-core framework: https://learn.microsoft.com/en-us/ef/core/managing-schemas/migrations
3434
35+
#### OnboardingServiceProvider - ENHANCED
36+
37+
- ENHANCED: table onboarding_service_provider_details "encryption_mode" added
38+
- ENHANCED: table onboarding_service_provider_details "initialization_vector" added
39+
40+
- ENHANCED: configuration for onboarding-service-provider:
41+
42+
```
43+
"OnboardingServiceProvider": {
44+
"EncryptionConfigIndex": 1,
45+
"EncryptionConfigs": [
46+
{
47+
"Index": 0,
48+
"EncryptionKey": "",
49+
"CipherMode": "",
50+
"PaddingMode": ""
51+
},
52+
{
53+
"Index": 1,
54+
"EncryptionKey": "",
55+
"CipherMode": "",
56+
"PaddingMode": ""
57+
}
58+
]
59+
}
60+
```
61+
62+
Previous OnboardingServiceProvider settings contained 'EncryptionKey'. Format was utf8-string being read as byte[].
63+
New format of EncryptionKey is 64 characters hex
64+
65+
Example:
66+
67+
- old format:
68+
69+
```
70+
"OnboardingServiceProvider": {
71+
"EncryptionKey": ")U\;>/h=ELj+.v5AD9(P2HQ3JnuYt.R:"
72+
}
73+
```
74+
75+
- including the details that before the change were defined in the source code the same configuration as 'index 0' in new format:
76+
77+
```
78+
"OnboardingServiceProvider": {
79+
"EncryptionConfigIndex": 1,
80+
"EncryptionConfigs": [
81+
{
82+
"Index": 0,
83+
"EncryptionKey": "29555c3b3e2f683d454c6a2b2e76354144392850324851334a6e7559742e523a",
84+
"CipherMode": "ECB",
85+
"PaddingMode": "PKCS7"
86+
},
87+
{
88+
"Index": 1,
89+
"EncryptionKey": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
90+
"CipherMode": "CBC",
91+
"PaddingMode": "PKCS7"
92+
}
93+
]
94+
}
95+
```
96+
97+
to ensure the new encryption is able to decrypt preexisting client_secrets the old encryption-key must be converted to the new format. This may be done on the command-line:
98+
99+
```
100+
echo -n ")U\;>/h=ELj+.v5AD9(P2HQ3JnuYt.R:" | xxd -p
101+
```
102+
35103
### v1.8.0
36104

37105
#### Agreements - ENHANCED

0 commit comments

Comments
 (0)