CSJCurrent en:About Verifications: Unterschied zwischen den Versionen
(Imported from text file) |
Keine Bearbeitungszusammenfassung |
||
(2 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 7: | Zeile 7: | ||
* If the Cryptshare Server is configured to use the [[{{NAMESPACE}}:Sender_Verification|Sender Verification]] mode, each email address that is used as the sender when using the Cryptshare services will need to be verified. | * If the Cryptshare Server is configured to use the [[{{NAMESPACE}}:Sender_Verification|Sender Verification]] mode, each email address that is used as the sender when using the Cryptshare services will need to be verified. | ||
* With [[{{NAMESPACE}}:Client_Verification|Client Verification]], the whole client system on which the API application is running is verified on the Cryptshare Server. Then that '''Client''' will be able to access the server's services using any sender address, without any further verification requirements. | * With [[{{NAMESPACE}}:Client_Verification|Client Verification]], the whole client system on which the API application is running is verified on the Cryptshare Server. Then that '''Client''' will be able to access the server's services using any sender address, without any further verification requirements. | ||
The verification mode can be configured on the [ | The verification mode can be configured on the [[CSSCurrent_en:Add_On_Products|Add-On Products]] tab of the Cryptshare Server: | ||
[[File:58296718.png]] | [[File:58296718.png]] | ||
= Checking the Verification = | = Checking the Verification = | ||
You can use API methods to check what kind of verification mode is configured on the server, and whether a given sender email address is verified, or if the verification mode is set to [[{{NAMESPACE}}:Client_Verification|Client Verification]], whether the '''Client''' is verified. | You can use API methods to check what kind of verification mode is configured on the server, and whether a given sender email address is verified, or if the verification mode is set to [[{{NAMESPACE}}:Client_Verification|Client Verification]], whether the '''Client''' is verified. | ||
As with all API operations, you first have to create the '''Client''' instance, as described under [[{{NAMESPACE}}:API_Functions|API Functions]]. Then you can call the '''Client''''s '''checkVerification()''' method to check the verification status. It will return a '''CheckVerificationResult''' instance, containing the queried verification status. | As with all API operations, you first have to create the '''Client''' instance, as described under [[{{NAMESPACE}}:API_Functions|API Functions]]. Then you can call the '''Client''''s '''checkVerification()''' method to check the verification status. It will return a '''CheckVerificationResult''' instance, containing the queried verification status. | ||
If the method '''getVerificationMode() == VerificationMode.SENDER''' in the '''VerificationStatus''' instance returns ''true'', then the verification mode on the server is configured to be [[{{NAMESPACE}}:Sender_Verification|Sender Verification]], if it returns ''false'', then the server is set to the [[{{NAMESPACE}}:Client_Verification|Client Verification]] mode. The method '''isUserVerified()''' will tell you whether the sender address you specified is verified or not. If the verification mode on the server is set to [[{{NAMESPACE}}:Client_Verification|Client Verification]] and the '''Client''' has not yet been verified, the method '''isUserVerified | If the method '''getVerificationMode() == VerificationMode.SENDER''' in the '''VerificationStatus''' instance returns ''true'', then the verification mode on the server is configured to be [[{{NAMESPACE}}:Sender_Verification|Sender Verification]], if it returns ''false'', then the server is set to the [[{{NAMESPACE}}:Client_Verification|Client Verification]] mode. The method '''isUserVerified()''' will tell you whether the sender address you specified is verified or not. If the verification mode on the server is set to [[{{NAMESPACE}}:Client_Verification|Client Verification]] and the '''Client''' has not yet been verified, the method '''isUserVerified()''' will return ''false''. If the '''Client''' has been verified, it will return ''true'' for all sender addresses. If the verification mode is set to [[{{NAMESPACE}}:Sender_Verification|Sender Verification]], then the method '''isUserVerified()''' will only return ''true'', if the sender address has actually been verified. | ||
'''Example: Checking the Verification Status''' | '''Example: Checking the Verification Status''' | ||
Aktuelle Version vom 3. Januar 2023, 08:21 Uhr
Verification Modes
Most of the services offered by the Cryptshare Server require a form of verification, before they can be used. The Cryptshare Server supports two types of verification: Sender Verification and Client Verification.
- If the Cryptshare Server is configured to use the Sender Verification mode, each email address that is used as the sender when using the Cryptshare services will need to be verified.
- With Client Verification, the whole client system on which the API application is running is verified on the Cryptshare Server. Then that Client will be able to access the server's services using any sender address, without any further verification requirements.
The verification mode can be configured on the Add-On Products tab of the Cryptshare Server:
Checking the Verification
You can use API methods to check what kind of verification mode is configured on the server, and whether a given sender email address is verified, or if the verification mode is set to Client Verification, whether the Client is verified. As with all API operations, you first have to create the Client instance, as described under API Functions. Then you can call the Client's checkVerification() method to check the verification status. It will return a CheckVerificationResult instance, containing the queried verification status. If the method getVerificationMode() == VerificationMode.SENDER in the VerificationStatus instance returns true, then the verification mode on the server is configured to be Sender Verification, if it returns false, then the server is set to the Client Verification mode. The method isUserVerified() will tell you whether the sender address you specified is verified or not. If the verification mode on the server is set to Client Verification and the Client has not yet been verified, the method isUserVerified() will return false. If the Client has been verified, it will return true for all sender addresses. If the verification mode is set to Sender Verification, then the method isUserVerified() will only return true, if the sender address has actually been verified.
Example: Checking the Verification Status // First create the Client instance // Create a WebServiceUri for your Cryptshare Server WebServiceUri serviceUri = new WebServiceUri("https://cryptshare.server.com"); // Create a CryptshareConnection instance for your WebServiceUri CryptshareConnection connection = new CryptshareConnection(serviceUri); // Create the Client instance with the sender's email address, // the CryptshareConnection, and the path to the verification store. Client client = new Client("sender_email@server.com", connection, Paths.get("C:\\\\temp\\\\client.store")); // now you can call the checkVerification() method on the client CheckVerificationResult result = client.checkVerification(); if (result.getVerificationMode() == VerificationMode.SENDER) { System.out.println("Verification mode is Sender Verification"); } else { System.out.println("Verification mode is Client Verification"); } if (result.isUserVerified()) { System.out.println("Sender address is verified!"); } else { System.out.println("Sender address is NOT verified!"); }