Fixed the javadoc

Author: ic0ns

Attacks/src/main/java/de/rub/nds/tlsattacker/attacks/ec/ICEAttacker.java

@@ -177,9 +177,13 @@ private void attackOracle() {
      * compute the server private key with CRT.
      * 
      * @param usedOracleEquations
+     *            The used oracle equations
      * @param congs
+     *            The congruences
      * @param modulis
+     *            The modulis
      * @param pointer
+     *            the pointer
      */
     public void bruteForceWithAdditionalOracleEquations(int[] usedOracleEquations, BigInteger[] congs,
             BigInteger[] modulis, int pointer) {
@@ -209,9 +213,12 @@ public void bruteForceWithAdditionalOracleEquations(int[] usedOracleEquations, B
      * Computes CRT from a given combination of congs and modulis
      * 
      * @param usedOracleEquations
+     *            The used oracle equations
      * @param congs
+     *            The congruences
      * @param modulis
-     * @return
+     *            The modulis
+     * @return CRTF
      */
     private BigInteger computeCRTFromCombination(int[] usedOracleEquations, BigInteger[] congs, BigInteger[] modulis) {
         BigInteger[] usedCongs = new BigInteger[usedOracleEquations.length];
@@ -235,7 +242,8 @@ private int[] initializeUsedOracleEquations(int size) {
      * Uses the oracle to get a congruence for a specific point
      * 
      * @param point
-     * @return
+     *            A Point
+     * @return The Congruence
      */
     private BigInteger getCongruence(ICEPoint point) {
         BigInteger secretModOrder = BigInteger.ZERO;

Attacks/src/main/java/de/rub/nds/tlsattacker/attacks/ec/ICEPointReader.java

@@ -28,7 +28,8 @@ public class ICEPointReader {
      * this named curve
      * 
      * @param namedCurve
-     * @return
+     *            The NamedCurve as a String
+     * @return the deserialized Points
      */
     public static List<ICEPoint> readPoints(String namedCurve) {
         String namedCurveLow = namedCurve.toLowerCase();

Attacks/src/main/java/de/rub/nds/tlsattacker/attacks/ec/oracles/ECOracle.java

@@ -34,8 +34,10 @@ public abstract class ECOracle {
      * secret was guessed correctly.
      * 
      * @param ecPoint
+     *            The Point
      * @param guessedSecret
-     * @return
+     *            The guessed Secret
+     * @return True if the secret is guessed correctly
      */
     public abstract boolean checkSecretCorrectnes(Point ecPoint, BigInteger guessedSecret);
 
@@ -45,7 +47,8 @@ public abstract class ECOracle {
      * correct.
      * 
      * @param guessedSecret
-     * @return
+     *            The guessed Secret
+     * @return True if the Solution is correct
      */
     public abstract boolean isFinalSolutionCorrect(BigInteger guessedSecret);
 

Attacks/src/main/java/de/rub/nds/tlsattacker/attacks/impl/Attacker.java

@@ -23,6 +23,7 @@
 
 /**
  * @param <Config>
+ *            The AttackConfig
  */
 public abstract class Attacker<Config extends AttackConfig> {
 

Attacks/src/main/java/de/rub/nds/tlsattacker/attacks/pkcs1/PKCS1VectorGenerator.java

@@ -37,8 +37,10 @@ public class PKCS1VectorGenerator {
      * Generates different encrypted PKCS1 vectors
      * 
      * @param publicKey
+     *            The publickey
      * @param type
-     * @return
+     *            the type
+     * @return pkcs1Vectors
      */
     public static byte[][] generatePkcs1Vectors(RSAPublicKey publicKey, BleichenbacherCommandConfig.Type type) {
 
@@ -70,8 +72,10 @@ public static byte[][] generatePkcs1Vectors(RSAPublicKey publicKey, Bleichenbach
      * Generates different plain PKCS1 vectors
      * 
      * @param publicKey
+     *            The publickey
      * @param type
-     * @return
+     *            the type
+     * @return pkcs1Vectors
      */
     public static byte[][] generatePlainPkcs1Vectors(RSAPublicKey publicKey, BleichenbacherCommandConfig.Type type) {
         // we do not need secure random here
@@ -115,7 +119,7 @@ public static byte[][] generatePlainPkcs1Vectors(RSAPublicKey publicKey, Bleiche
      *            rsa key length in bytes
      * @param symmetricKeyLength
      *            symmetric key length in bytes
-     * @return
+     * @return padded key
      */
     private static byte[] getPaddedKey(int rsaKeyLength, byte[] symmetricKey) {
         byte[] key = new byte[rsaKeyLength];
@@ -194,8 +198,10 @@ private static byte[] getEK_SymmetricKeyOfSize(int rsaKeyLength, byte[] symmetri
 
     /**
      * @param rsaKeyLength
+     *            rsakeylength
      * @param symmetricKey
-     * @return
+     *            symmetric key
+     * @return differentpositions
      */
     private static byte[][] getEK_DifferentPositionsOf0x00(int rsaKeyLength, byte[] symmetricKey) {
         byte[][] result = new byte[rsaKeyLength - 2][];

TLS-Core/src/main/java/de/rub/nds/tlsattacker/core/constants/BulkCipherAlgorithm.java

@@ -28,7 +28,8 @@ public enum BulkCipherAlgorithm {
 
     /**
      * @param cipherSuite
-     * @return
+     *            The CipherSuite to choose the BulkCipherAlgorithm from
+     * @return The BulkCipherAlgorithm of the Ciphersuite
      */
     public static BulkCipherAlgorithm getBulkCipherAlgorithm(CipherSuite cipherSuite) {
         String cipher = cipherSuite.toString().toUpperCase();

TLS-Core/src/main/java/de/rub/nds/tlsattacker/core/protocol/handler/ProtocolMessageHandler.java

@@ -60,6 +60,9 @@ public byte[] prepareMessage(Message message) {
      * hooks.
      *
      * @param message
+     *            The message that should be prepared
+     * @param withPrepare
+     *            if the prepare function should be called or only the rest
      * @return message in bytes
      */
     public byte[] prepareMessage(Message message, boolean withPrepare) {

TLS-Core/src/main/java/de/rub/nds/tlsattacker/core/record/cipher/RecordBlockCipher.java

@@ -136,6 +136,7 @@ private void setNextIv(byte[] ciphertext) {
      *            correctly padded data
      * @return The raw decrypted Bytes
      * @throws CryptoException
+     *             If something goes wrong during decryption
      */
     @Override
     public byte[] decrypt(byte[] data) throws CryptoException {

TLS-Core/src/main/java/de/rub/nds/tlsattacker/core/state/ContextContainer.java

@@ -50,13 +50,13 @@ public class ContextContainer {
     /**
      * Get the only defined TLS context.
      * <p>
+     * </p>
      * Convenience method, useful when working with a single context only.
      *
      * @return the only known TLS context
      * @throws ConfigurationException
      *             if there is more than one TLS context in the container
      * 
-     * @see this.getTlsContext(String)
      */
     public TlsContext getTlsContext() {
         if (tlsContexts.isEmpty()) {
@@ -75,8 +75,6 @@ public TlsContext getTlsContext() {
      * @throws ConfigurationException
      *             if there is no TLS context with the given alias
      * 
-     * @see this.getTlsContext() convenience method for accessing single
-     *      contexts
      */
     public TlsContext getTlsContext(String alias) {
         TlsContext ctx = tlsContexts.get(alias);
@@ -158,6 +156,7 @@ public void removeTlsContext(String alias) {
     /**
      * Replace existing TlsContext with new TlsContext.
      * <p>
+     * </p>
      * The TlsContext can only be replaced if the connection of both the new and
      * the old TlsContext equal.
      * 

TLS-Core/src/main/java/de/rub/nds/tlsattacker/core/state/State.java

@@ -43,13 +43,13 @@
  * TLS contexts for workflow execution. These contexts should be considered as
  * dynamic objects, representing TLS connections, calculations and other data
  * exchanged during the TLS actual workflow execution.
- * <p>
+ * </p>
  *
  * <p>
  * Therefore, there is no public interface for setting TLS contexts manually.
  * They are always automatically created based on the connections defined in the
  * workflow trace.
- * <p>
+ * </p>
  * 
  * <p>
  * Please also have a look at the tests supplied with this class for some
@@ -153,6 +153,7 @@ public WorkflowTrace getOriginalWorkflowTrace() {
      * existingTlsContext.connection equals newTlsContext.connection.
      * 
      * @param newTlsContext
+     *            The new TlsContext to replace the old with
      */
     public void replaceTlsContext(TlsContext newTlsContext) {
         contextContainer.replaceTlsContext(newTlsContext);
@@ -169,9 +170,7 @@ public void replaceTlsContext(TlsContext newTlsContext) {
      * TODO: Ideally, this would return a deep copy to prevent State
      * invalidation.
      * 
-     * @return the only context known to the state <<<<<<< HEAD
-     * @see this.getTlsContext(String) =======
-     * @see #getTlsContext(java.lang.String) >>>>>>> origin/master
+     * @return the only context known to the state
      */
     public TlsContext getTlsContext() {
         return contextContainer.getTlsContext();
@@ -181,19 +180,17 @@ public TlsContext getTlsContext() {
      * Get TLS context with given alias. Aliases are the ones assigned to the
      * corresponding connection ends.
      * 
-     * <<<<<<< HEAD Note: Be careful when changing the context. I.e. if you
-     * change it's connection, the state can get out of sync.
+     * Note: Be careful when changing the context. I.e. if you change it's
+     * connection, the state can get out of sync.
      * 
      * TODO: Ideally, this would return a deep copy to prevent State
      * invalidation.
      * 
-     * =======
      * 
      * @param alias
-     *            The Alias for which the TLSContext should be returned >>>>>>>
-     *            origin/master
+     *            The Alias for which the TLSContext should be returned
+     * 
      * @return the context with the given connection end alias
-     * @see #getTlsContext()
      */
     public TlsContext getTlsContext(String alias) {
         return contextContainer.getTlsContext(alias);