Skip to content

Commit 5412eb9

Browse files
Update wallet_location documentation to include PEM support and password handling (#192)
1 parent 5449702 commit 5412eb9

File tree

5 files changed

+78
-12
lines changed

5 files changed

+78
-12
lines changed

ojdbc-provider-aws/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,23 @@ The `oracle.net.wallet_location` connection property is not allowed in the `jdbc
161161

162162
For the JSON type of provider (AWS S3, HTTPS, File) the wallet_location is an object itself with the same spec as the [password JSON object](#password-json-object) mentioned above.
163163

164-
The value stored in the secret should be the Base64 representation of the bytes in `cwallet.sso`. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
164+
The value stored in the secret should be the Base64 representation of of a supported wallet file. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
165165

166166
```
167-
data:;base64,<Base64 representation of the bytes in cwallet.sso>
167+
data:;base64,<Base64 representation of the wallet file>
168+
```
169+
170+
#### Supported formats
171+
- `cwallet.sso` (SSO wallet)
172+
- `ewallet.pem` (PEM wallet)
173+
174+
If the PEM wallet is encrypted, you must also set the wallet password using the `oracle.net.wallet_password` property.
175+
This property should be included inside the jdbc object of the JSON payload:
176+
177+
```
178+
"jdbc": {
179+
"oracle.net.wallet_password": "<your-password>"
180+
}
168181
```
169182

170183
<i>*Note: When storing a wallet in AWS Secrets Manager, store the raw Base64-encoded wallet bytes directly. The provider will automatically detect and handle the encoding correctly.</i>

ojdbc-provider-azure/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,23 @@ The `oracle.net.wallet_location` connection property is not allowed in the `jdbc
139139

140140
For the JSON type of provider (Azure Key Vault, HTTPS, File) the `wallet_location` is an object itself with the same spec as the [password JSON object](#password-json-object) mentioned above.
141141

142-
The value stored in the secret should be the Base64 representation of the bytes in `cwallet.sso`. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
142+
The value stored in the secret should be the Base64 representation of a supported wallet file. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
143143

144144
```
145-
data:;base64,<Base64 representation of the bytes in cwallet.sso>
145+
data:;base64,<Base64 representation of the wallet file>
146+
```
147+
148+
#### Supported formats
149+
- `cwallet.sso` (SSO wallet)
150+
- `ewallet.pem` (PEM wallet)
151+
152+
If the PEM wallet is encrypted, you must also set the wallet password using the `oracle.net.wallet_password` property.
153+
This property should be included inside the jdbc object of the JSON payload:
154+
155+
```
156+
"jdbc": {
157+
"oracle.net.wallet_password": "<your-password>"
158+
}
146159
```
147160

148161
<i>*Note: When storing a wallet in Azure Key Vault, store the raw Base64-encoded wallet bytes directly. The provider will automatically detect and handle the encoding correctly.</i>

ojdbc-provider-gcp/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,25 @@ For the JSON type of provider (GCP Cloud Storage, HTTPS, File) the `wallet_locat
171171

172172
The value stored in the secret can be either:
173173

174-
- The Base64 representation of the bytes in cwallet.sso.
175-
- The raw bytes of the cwallet.sso file, stored as an imported file.
174+
- The Base64 representation of a supported wallet file.
175+
- The raw bytes of the wallet file, stored as an imported secret.
176176

177-
In both cases, the provider will automatically handle the content. If the secret contains raw bytes (e.g., an imported cwallet.sso file), the provider will perform Base64 encoding as needed. The resulting format is equivalent to setting the oracle.net.wallet_location connection property in a regular JDBC application using the following format:
177+
In both cases, the provider will automatically handle the content. If the secret contains raw bytes (e.g., an imported `cwallet.sso` or `ewallet.pem` file), the provider will perform Base64 encoding as needed. The resulting format is equivalent to setting the oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
178178
```
179-
data:;base64,<Base64 representation of the bytes in cwallet.sso>
179+
data:;base64,<Base64 representation of the wallet file>
180+
```
181+
182+
#### Supported formats
183+
- `cwallet.sso` (SSO wallet)
184+
- `ewallet.pem` (PEM wallet)
185+
186+
If the PEM wallet is encrypted, you must also set the wallet password using the `oracle.net.wallet_password` property.
187+
This property should be included inside the jdbc object of the JSON payload:
188+
189+
```
190+
"jdbc": {
191+
"oracle.net.wallet_password": "<your-password>"
192+
}
180193
```
181194

182195
<i>*Note: When storing a wallet in GCP Secret Manager, you can either store the raw bytes of the cwallet.sso file directly or provide the Base64-encoded string. The provider will detect the format and handle the encoding appropriately.</i>

ojdbc-provider-hashicorp/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,10 +584,24 @@ The `oracle.net.wallet_location` connection property is not allowed in the `jdbc
584584

585585
For the JSON type of provider (HCP Vault Dedicated, HCP Vault Secrets, HTTPS, File) the `wallet_location` is an object itself with the same spec as the [password JSON object](#password-json-object) mentioned above.
586586

587-
The value stored in the secret should be the Base64 representation of the bytes in `cwallet.sso`. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
587+
The value stored in the secret should be the Base64 representation of a supported wallet file. This is equivalent to setting the `oracle.net.wallet_location` connection property in a regular JDBC application using the following format:
588588

589589
```
590-
data:;base64,<Base64 representation of the bytes in cwallet.sso>
590+
data:;base64,<Base64 representation of the wallet file>
591+
```
592+
593+
594+
#### Supported formats
595+
- `cwallet.sso` (SSO wallet)
596+
- `ewallet.pem` (PEM wallet)
597+
598+
If the PEM wallet is encrypted, you must also set the wallet password using the `oracle.net.wallet_password` property.
599+
This property should be included inside the jdbc object of the JSON payload:
600+
601+
```
602+
"jdbc": {
603+
"oracle.net.wallet_password": "<your-password>"
604+
}
591605
```
592606

593607
<i>*Note: When storing a wallet in HCP Vault Dedicated or HCP Vault Secrets, store the raw Base64-encoded wallet bytes directly. The provider will automatically detect and handle the encoding correctly.</i>

ojdbc-provider-oci/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,23 @@ The "oracle.net.wallet_location" connection property is not allowed in the "jdbc
186186

187187
For the JSON type of provider (OCI Object Storage, HTTPS, File) the wallet_location is an object itself with the same spec as the [password JSON object](#password-json-object) mentioned above.
188188

189-
The value stored in the secret should be the Base64 representation of the bytes in cwallet.sso. This is equivalent to setting the "oracle.net.wallet_location" connection property in a regular JDBC application using the following format:
189+
The value stored in the secret should be the Base64 representation of a supported wallet file. This is equivalent to setting the "oracle.net.wallet_location" connection property in a regular JDBC application using the following format:
190190

191191
```
192-
data:;base64,<Base64 representation of the bytes in cwallet.sso>
192+
data:;base64,<Base64 representation of the wallet file>
193+
```
194+
195+
#### Supported formats:
196+
- `cwallet.sso` (SSO Wallet)
197+
- `ewallet.pem`(PEM Wallet)
198+
199+
If the PEM wallet is encrypted, you must also set the wallet password using the `oracle.net.wallet_password` property.
200+
This property should be included inside the "jdbc" object of the JSON payload.
201+
202+
```
203+
"jdbc": {
204+
"oracle.net.wallet_password": "<your-password>"
205+
}
193206
```
194207

195208
<i>*Note: When storing a wallet as a secret in OCI Vault, choose the Plain-Text secret type template instead of Base64 to prevent double decoding when the provider retrieves the value.</i>

0 commit comments

Comments
 (0)