Viele APIs erfordern, dass der Aufrufende Authentifizierungsinformationen angibt, um die Identität – und möglicherweise die Zugriffsberechtigungen – des Aufrufenden zu verifizieren. Authentifizierungsinformationen können über den HTTP-Header (Basic/NTLM/Digest-Authentifizierung), durch Austausch von Zugriffs-Tokens (OAuth), indem vom Client die Mitgabe eines Client-Zertifikats in der Anfrage erwartet wird oder eine Kombination davon weitergegeben werden.
In diesem Artikel werden Optionen für Client-Zertifikate behandelt. Um die üblichen Authentifizierungsmethoden einzurichten, lies bitte den Artikel zu Authentifizierungsarten.
Typen von Client-Zertifikaten
Der Abschnitt „Client Zertifikat“ auf der Registerkarte „Schritte“ unter „Request“ bei einem Multi-step API Monitoring-Prüfobjekt stellt die folgenden Optionen bereit. Wenn Du mehrere Schritte in Deiner Schritt-Definition verwendest, stelle bitte sicher, dass bei jedem Schritt die gewünschten Einstellungen vorliegen.
- Uptrends Client Zertifikat: Diese Option ist nützlich, wenn Du von API-Nutzern verlangst, ihr eigenes Client-Zertifikat zu erzeugen und mitzuliefern, um ihre Identität zu beweisen. Wenn Du diese Option wählst, wird ein Uptrends gehörendes Zertifikat mitgesendet, wenn die HTTP-Anfrage übermittelt wird. Deine API kann die eingehende Anfrage anhand des entsprechenden öffentlichen Schlüssels (Public Key) verifizieren. Passen die Schlüssel zusammen, kannst Du sicher sein, dass die Anfrage von jemandem stammt, der das Originalzertifikat (d. h. Uptrends) besitzt, – niemandem sonst. Weitere Informationen findest Du im Artikel über Uptrends' Informationen zum Public Key (öffentlichen Schlüssel).
- Individuelles Client Zertifikat: Wähle diese Option, wenn Du das mit der Anfrage mitzugebende Client-Zertifikat besitzt oder kontrollierst. Sobald Du die Zertifikatsdatei nach Uptrends hochgeladen hast, kannst Du sie in das Prüfobjekt des Multi-step API Monitorings aufnehmen. Da Dir das Zertifikat gehört, wird die API in der Lage sein, eingehende Anfragen, die es nutzen, zu verifizieren. Lies den nächsten Abschnitt, um dies einzurichten.
- Kein: Wähle Kein, wenn Du kein Client-Zertifikat für die HTTP-Anfrage nutzt.
Einrichten eines benutzerdefinierten bzw. individuellen Client-Zertifikats
Um ein Client-Zertifikat in das Prüfobjekt des Multi-step API Monitorings aufzunehmen, musst Du es zunächst nach Uptrends hochladen. Zertifikate (und andere sensible Informationen) werden in Deine Vault hochgeladen und gespeichert. Sobald Du der Vault eine Zertifikatsdatei hinzugefügt hast, kannst Du sie in der Monitoring-Einrichtung nutzen.
Hochladen eines Client-Zertifikats
Wenn Du Dich für die Option des individuellen Client-Zertifikats zum ersten Mal entscheidest, wirst Du sehen, dass noch keine Zertifikate verfügbar sind. Um ein Zertifikat hinzuzufügen, klicke auf Item hinzufügen, um zur Vault zu wechseln. Alternativ gehe nach Account > Vault über das Hauptmenü und klicke auf Vault Item hinzufügen.
Auf der Seite Neues Vault Item gibst Du einen einzigartigen Namen für das Zertifikat ein, damit Du es später wiedererkennst. Stelle sicher, dass der Typ des neuen Vault Items auf Zertifikats-Archiv eingestellt ist. Gib im Beschreibungsfeld jedwede Anmerkungen an, die Dir wichtig erscheinen.
Wähle schließlich eine Zertifikatsdatei aus, die Du hochladen möchtest. Die Datei muss dem Format PKCS #12 entsprechen oder ein Zertifikats-Archiv sein, das sowohl den privaten wie den öffentlichen Schlüssel enthält. Dateien im Format PKCS #12 haben die Erweiterung .pfx oder .p12.
Eine Zertifikats-Archivsdatei ist in der Regel verschlüsselt, sodass wir das zugehörige Passwort benötigen, um das Archiv zu verwenden. Bitte gib das Passwort im Feld Archiv-Password an und klicke auf Speichern.
Einsatz von Client-Zertifikaten in einem Prüfobjekt des Multi-step Monitorings
Sobald Du in der Vault ein geeignetes Client-Zertifikat gespeichert hast, kannst Du es in einem Multi-step API Monitoring nutzen. Klicke im Abschnitt Client-Zertifikat eines Schritts auf Aktualisieren, um die Liste der verfügbaren Zertifikate zu aktualisieren. Wähle abschließend das entsprechende Zertifikat für jeden Schritt, der ein Zertifikat erfordert.