Verschlüsselte APIKey-Anforderung
Bei ' ibm-appconfiguration-js-client-sdk und ' ibm-appconfiguration-react-client-sdk müssen die Benutzer nun einen verschlüsselten Client SDK APIKey anstelle des Klartext-APIKeys angeben, um die Sicherheit
zu erhöhen. Dadurch wird verhindert, dass der APIKey bei der Inspektion der Webseite mit Hilfe von Browsern offengelegt wird.
Um ein Höchstmaß an Sicherheit zu gewährleisten, verwenden wir während des Verschlüsselungsvorgangs eine zufällige Nonce. Daher ist der verschlüsselte Wert jedes Mal, wenn Sie Ihren APIKey verschlüsseln, anders, aber der zugrunde liegende Klartext bleibt derselbe, wenn er bei der Authentifizierung entschlüsselt wird.
Schritte zum Erzeugen und Verwenden des verschlüsselten Client-SDK-APIKeys
- Beziehen Sie Ihren einfachen APIKey:
- Navigieren Sie zum Abschnitt Service Credentials Ihrer App Configuration Instanz im IBM Cloud Dashboard.
- Erzeugen Sie einen APIKey für die Rolle "
Client SDKund kopieren Sie den Apikey aus den Anmeldedaten des Dienstes.
- Verschlüsseln Sie Ihren APIKey:
-
Verwenden Sie den folgenden API-Endpunkt, um Ihren einfachen APIKey zu verschlüsseln
POST /apprapp/feature/v1/instances/<guid>/encryptBeispiel:
https://eu-gb.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/720f9034-c990-4305-96d6-4f65ffacef2c/encrypt -
Geben Sie im Text der Anfrage Ihren einfachen APIKey wie folgt an:
{ "client_sdk_apikey": "your_plain_apikey" } -
Die Antwort enthält Ihren AES-256 APIKey.
-
- Aktualisieren Sie Ihren Code:
Javascript SDK: Aktualisieren Sie Ihren Initialisierungscode:
- Ersetzen Sie die Verwendung des einfachen APIKeys in Ihrer Anwendung durch den verschlüsselten APIKey. Nachstehend finden Sie ein aktualisiertes Beispiel für die Initialisierung des SDK unter Verwendung des verschlüsselten APIKeys:
const region = AppConfiguration.REGION_US_SOUTH; // Geben Sie Ihre Region an
const guid = '<guid>'; // Instanz-ID aus dem Dienst Credentials
const apikey = '<encrypted_apikey>'; // Verwendung des verschlüsselten APIKeys
const collectionId = 'airlines-webapp'; // Your collection ID
const environmentId = 'dev'; // Your environment ID
const appConfigClient = AppConfiguration.getInstance();
async function initialiseAppConfig() {
appConfigClient.init(region, guid, apikey); // Initialize with encrypted APIKey
await appConfigClient.setContext(collectionId, environmentId);
}
try {
await initialiseAppConfig();
console.log("App configuration SDK initialized successfully");
} catch (e) {
console.error("Failed to initialize app configuration SDK", e);
}
```
**React SDK:**
Aktualisieren Sie Ihren AppConfigProvider Code:
- Ersetzen Sie die Verwendung des einfachen APIKeys in Ihrer Anwendung durch den verschlüsselten APIKey. Nachstehend finden Sie ein aktualisiertes Beispiel für die Initialisierung des SDK unter Verwendung des verschlüsselten APIKeys:
```js
importiere { withAppConfigProvider } von 'ibm-appconfiguration-react-client-sdk';
(async () => {
const AppConfigProvider = await withAppConfigProvider({
region: 'us-south', // Specify your region
guid: '<guid>', // Instance ID from Service Credentials
apikey: '<encrypted_apikey>', // Use the encrypted APIKey
collectionId: 'airlines-webapp', // Your collection ID
environmentId: 'dev' // Your environment ID
})
ReactDOM.render(
<AppConfigProvider>
<YourApp />
</AppConfigProvider>,
document.getElementById('root')
);
})();
```
## Bestehende Benutzer: Aktualisierung erforderlich {: #ac-existing-users-update}
Wenn Sie bereits einen einfachen APIKey verwenden, aktualisieren Sie Ihre Anwendung, um den verschlüsselten APIKey gemäß den vorherigen Schritten zu generieren und zu verwenden.
<!-- v2.4.8 : caits-prod-app-clouddocs_cloud-docs-app-configuration_20250808T171821-4_en_de -->