Creazione di alias di chiavi

Si può usare IBM® Key Protect for IBM Cloud® per creare un alias di chiave con l'API Key Protect API.

Si può usare IBM® Key Protect for IBM Cloud® per creare un alias di chiave con la console Key Protect.

Gli alias delle chiavi sono nomi unici leggibili dall'uomo, riferimenti a una chiave che ne consentono l'identificazione e il raggruppamento oltre i limiti del nome visualizzato. Gli alias consentono al servizio di fare riferimento a una chiave con nomi personalizzati riconoscibili, anziché con l'identificatore generato automaticamente dal servizio Key Protect. Ad esempio, se si crea una chiave con ID 02fd6835-6001-4482-a892-13bd2085f75d e alias US-South-Test-Key, si può usare l'alias US-South-Test-Key per fare riferimento alla chiave quando si chiama l'API Key Protect per recuperare una chiave o i suoi metadati. L'alias può essere usato anche per organizzare le chiavi nella console Key Protect.

Creare e modificare gli alias dei tasti con la console

Gli alias delle chiavi possono essere aggiunti a una chiave durante il processo di creazione o importazione di una chiave.

Per ulteriori informazioni sulla creazione di una chiave principale o di una chiave standard, consultare Creazione di chiavi principali o Creazione di chiavi standard.
Per ulteriori informazioni sull'importazione di una chiave principale o di una chiave standard, consultare Importazione di chiavi principali o Importazione di chiavi standard.

Per modificare un alias chiave, fare clic su ⋯ e selezionare Modifica alias chiave. Nella scheda verranno visualizzati gli alias esistenti assegnati alla chiave (e sarà possibile eliminarli) e sarà possibile aggiungere altri alias. Una chiave può avere fino a cinque alias.

Creazione di alias di chiavi con l'API

Creare un alias chiave effettuando una chiamata POST al seguente endpoint.

https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<alias>

Richiama le tue credenziali di autenticazione per lavorare con le chiavi nel servizio.

Per creare un alias chiave, è necessario essere assegnati al ruolo di accesso al servizio Manager o Writer o Writer. Per conoscere la corrispondenza dei ruoli IAM con azioni di servizio Key Protect, controllare Ruoli di accesso al servizio.

Creare un alias di chiave eseguendo il seguente curl comando.

$ curl -X POST \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<key_alias>" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>" \
    -H "content-type: application/vnd.ibm.kms.key+json" \
    -H "correlation-id: <correlation_ID>"

Sostituisci le variabili nella richiesta di esempio in base alla seguente tabella.

Descrive le variabili necessarie per creare un alias di chiave con l'API Key Protect API
Variabile	Descrizione
regione	Richiesto. L'abbreviazione della regione, come `us-south` `eu-gb`, che rappresenta l'area geografica in cui risiede l'istanza Key Protect. For more information, see Punti di riferimento del servizio regionale.
keyID_or_alias	Richiesto. L'identificatore o l'alias della chiave che si desidera associare a un alias. Per recuperare l'ID di una chiave, vedere l'API List Keys.
chiave_alias	Richiesto. Un nome leggibile dall'utente e univoco per una facile identificazione della tua chiave. Alias must be alphanumeric, case sensitive, and cannot contain spaces or special characters other than dashes (-) or underscores (_). The alias cannot be a version 4 UUID and must not be a Key Protect reserved name: allowed_ip, key, keys, metadata, policy, policies, registration, registrations, ring, rings,rotate, wrap, unwrap, rewrap, version, versions.Alias size can be between 2 - 90 characters (inclusive). Note You cannot have duplicate alias names in your Key Protect instance.
IAM_token	Richiesto. Il tuo token di accesso IBM Cloud. Includere il contenuto completo del token IAM, compreso il valore del Bearer, nella richiesta di curl For more information, see Recupero di un token di accesso.
instance_id	Richiesto. L'identificatore unico assegnato all'istanza del servizio Key Protect For more information, see Recupero dell'ID di un'istanza.
iD correlazione	Facoltativo: l'identificativo univoco utilizzato per tracciare e correlare le transazioni.

Per proteggere la riservatezza dei vostri dati personali, evitate di inserire informazioni di identificazione personale (PII), come il nome o l'ubicazione, quando si crea un alias chiave. Per ulteriori esempi di PII, si veda la sezione 2.2 della Pubblicazione speciale NIST 800-122.

Una risposta POST api/v2/keys/<keyID_or_alias>/aliases/<key_alias> riuscita restituisce l'alias della chiave, insieme ad altri metadati. L'alias è un nome nome univoco che viene assegnato alla chiave e che può essere utilizzato per recuperare ulteriori informazioni sulla chiave associata.

{
    "metadata": {
        "collectionType": "application/vnd.ibm.kms.key+json",
        "collectionTotal": 1
    },
    "resources": [
        {
            "keyId": "02fd6835-6001-4482-a892-13bd2085f75d",
            "alias": "test-alias",
            "creationDate": "2020-03-12T03:37:32Z",
            "createdBy": "..."
        }
    ]
}

Per una descrizione dettagliata dei parametri di risposta, si veda il file Key Protect Documento di riferimento dell'API REST.

Ogni chiave può avere fino a cinque alias. C'è un limite di 1.000 alias per istanza istanza.

Eliminazione degli alias delle chiavi con l'API

Eliminare un alias chiave effettuando una chiamata DELETE al seguente endpoint.

https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<alias>

Richiama le tue credenziali di autenticazione per lavorare con le chiavi nel servizio.

Eliminare un alias chiave eseguendo il seguente curl comando.

$ curl -X DELETE \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/aliases/<key_alias>" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>" \
    -H "content-type: application/vnd.ibm.kms.key+json" \
    -H "correlation-id: <correlation_ID>"

Sostituisci le variabili nella richiesta di esempio in base alla seguente tabella.

Descrive le variabili necessarie per cancellare un alias chiave con l'API Key Protect API
Variabile	Descrizione
regione	Richiesto. L'abbreviazione della regione, come `us-south` `eu-gb`, che rappresenta l'area geografica in cui risiede l'istanza Key Protect For more information, see Punti di riferimento del servizio regionale.
keyID_or_alias	Richiesto. L'identificatore o l'alias della chiave recuperata al punto 1.
chiave_alias	Richiesto. Il nome unico, leggibile dall'uomo, che identifica la chiave.
IAM_token	Richiesto. Il tuo token di accesso IBM Cloud. Includere il contenuto completo del token IAM, compreso il valore del Bearer, nella richiesta di curl For more information, see Recupero di un token di accesso.
instance_id	Richiesto. L'identificativo univoco che viene assegnato alla tua istanza del servizio Key Protect. For more information, see Recupero dell'ID di un'istanza.
iD correlazione	Facoltativo: l'identificativo univoco utilizzato per tracciare e correlare le transazioni.

Una richiesta DELETE api/v2/keys/<keyID_or_alias>/aliases/<key_alias> andata a buon fine restituisce una risposta HTTP 204 No Content che indica che l'alias associato alla chiave è stato cancellato.

L'eliminazione completa di un alias dal servizio richiede fino a cinque minuti.

Alias chiave FAQ

Di seguito sono riportati ulteriori dettagli sugli alias delle chiavi:

Un alias è indipendente da una chiave. Un alias è una risorsa a sé stante e qualsiasi azione eseguita su di esso non influisce sulla chiave associata chiave associata. Ad esempio, l'eliminazione di un alias non comporta l'eliminazione della chiave associata associato.
Un alias può essere associato a una sola chiave alla volta. Un alias può essere associato a una sola chiave che si trova nella stessa istanza e regione istanza e regione. Se si desidera cambiare la chiave a cui è associato l'alias, è necessario eliminare l'alias, attendere fino a cinque minuti e associato, è necessario eliminare l'alias, attendere fino a cinque minuti, quindi ricreare l'alias e mapparlo sulla chiave necessaria.
È possibile creare un alias con lo stesso nome in un'istanza o in una regione diversa. Ogni alias sarà associato a una chiave diversa in ogni istanza o regione. Ciò consente al codice dell'applicazione del servizio di essere riutilizzabile in diverse istanze o regioni istanze o regioni diverse. Ad esempio, se si ha un alias chiamato Application Key in both the US-South and US-East regions, with each linked to a different key.

API che utilizzano alias di chiavi

La tabella seguente elenca le API che si possono utilizzare per creare e utilizzare una chiave alias.

Descrive le variabili che sono API che utilizzano alias chiave.
API	Impatto dell'alias chiave
Creare le chiavi radice	È possibile creare fino a 5 alias durante la creazione di una chiave principale.
Creare chiavi standard	È possibile creare fino a 5 alias durante la creazione di una chiave standard.
Richiama una chiave	È possibile recuperare una chiave in base all'ID o all'alias.
Visualizzare i metadati chiave	È possibile recuperare i metadati di una chiave per ID o alias.