Merge pull request #258 from vanitasvitae/xep373refs

Update references to XEP-0373
This commit is contained in:
Florian Schmaus 2018-07-30 15:57:21 +02:00 committed by GitHub
commit 101a0dbc38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 13 deletions

View File

@ -22,9 +22,8 @@ public interface AskForBackupCodeCallback {
* This callback is used to ask the user to provide a backup code.
* The backup code must follow the format described in XEP-0373 §5.3
*
* TODO: Update reflink
* @see <a href="https://xmpp.org/extensions/xep-0373.html#sect-idm139662753819792">
* XEP-0373 §5.3 about the format of the backup code</a>
* @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
* XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
*
* @return backup code provided by the user.
*/

View File

@ -23,9 +23,8 @@ public interface DisplayBackupCodeCallback {
* The client can then go ahead and display the code to the user.
* The backup code follows the format described in XEP-0373 §5.3
*
* TODO: Update reflink
* @see <a href="https://xmpp.org/extensions/xep-0373.html#sect-idm139662753819792">
* XEP-0373 §5.3 about the format of the backup code</a>
* @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
* XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
*
* @param backupCode backup code
*/

View File

@ -25,8 +25,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* This class represents a secretkey element which contains a users OpenPGP secret key.
*
* TODO: Update reflink
* @see <a href="https://xmpp.org/extensions/xep-0373.html#sect-idm46443026813600">
* @see <a href="https://xmpp.org/extensions/xep-0373.html#client-receives-secret-response">
* XEP-0373: §5.2.2 PEP Service Success Response</a>
*/
public class SecretkeyElement implements ExtensionElement {

View File

@ -45,8 +45,8 @@ public class SecretKeyBackupHelper {
* Generate a secure backup code.
* This code can be used to encrypt a secret key backup and follows the form described in XEP-0373 §5.3.
*
* TODO: Update reflink
* @see <a href="https://xmpp.org/extensions/xep-0373.html#sect-idm140425111347232">XEP-0373 §5.3</a>
* @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
* XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
*
* @return backup code
*/
@ -112,9 +112,8 @@ public class SecretKeyBackupHelper {
* Create a {@link SecretkeyElement} which contains the secret keys which are serialized in {@code keys} and is
* symmetrically encrypted using the {@code backupCode}.
*
* TODO: Update reflink
* @see <a href="https://xmpp.org/extensions/xep-0373.html#sect-idm45948286262768">
* XEP-0373 about secret key backup requirements</a>
* @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
* XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
*
* @param keys serialized OpenPGP secret keys in transferable key format
* @param backupCode passphrase for symmetric encryption