nilsteampassnet / TeamPass

includes/libraries/Tree/NestedTree/NestedTree.php

Doc Comments +1 added lines

@@ -443,6 +443,7 @@
      * @param int $id    The ID of the current node to process
      * @param int $level The nlevel to assign to the current node
      * @param   int     &$n     A reference to the running tally for the n-value
+     * @param integer $n
      */
     public function generateTreeData(&$arr, $id, $level, &$n)
     {

install/install.queries.php

Doc Comments +1 added lines

@@ -50,6 +50,7 @@
  * genHash()
  *
  * Generate a hash for user login
+ * @param string $password
  */
 function bCrypt($password, $cost)
 {

install/js/crypt/aes.class.php

Doc Comments +13 added lines

@@ -40,6 +40,10 @@ 
     return $output;
   }
 
+  /**
+   * @param integer $rnd
+   * @param integer $Nb
+   */
   private static function addRoundKey($state, $w, $rnd, $Nb) {  // xor Round Key into state S [é5.1.4]
     for ($r=0; $r<4; $r++) {
       for ($c=0; $c<$Nb; $c++) $state[$r][$c] ^= $w[$rnd*4+$c][$r];
@@ -48,6 +52,9 @@ 
     return $state;
   }
 
+  /**
+   * @param integer $Nb
+   */
   private static function subBytes($s, $Nb) {    // apply SBox to state S [é5.1.1]
     for ($r=0; $r<4; $r++) {
       for ($c=0; $c<$Nb; $c++) $s[$r][$c] = self::$sBox[$s[$r][$c]];
@@ -56,6 +63,9 @@ 
     return $s;
   }
 
+  /**
+   * @param integer $Nb
+   */
   private static function shiftRows($s, $Nb) {    // shift row r of state S left by r bytes [é5.1.2]
     $t = array(4);
     for ($r=1; $r<4; $r++) {
@@ -65,6 +75,9 @@ 
     return $s;  // see fp.gladman.plus.com/cryptography_technology/rijndael/aes.spec.311.pdf
   }
 
+  /**
+   * @param integer $Nb
+   */
   private static function mixColumns($s, $Nb) {   // combine bytes of each col of state S [é5.1.3]
     for ($c=0; $c<4; $c++) {
       $a = array(4);  // 'a' is a copy of the current column from 's'

install/js/crypt/aesctr.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
    * @param plaintext source text to be encrypted
    * @param password  the password to use to generate a key
    * @param nBits     number of bits to be used in the key (128, 192, or 256)
-   * @return          encrypted text
+   * @return          string text
    */
   public static function encrypt($plaintext, $password, $nBits)
   {
@@ -84,7 +84,7 @@ 
    * @param ciphertext source text to be decrypted
    * @param password   the password to use to generate a key
    * @param nBits      number of bits to be used in the key (128, 192, or 256)
-   * @return           decrypted text
+   * @return           string text
    */
   public static function decrypt($ciphertext, $password, $nBits)
   {

install/upgrade.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 ################
 ## Function permits to get the value from a line
 ################
+/**
+ * @param string $val
+ */
 function getSettingValue($val)
 {
     $val = trim(strstr($val, "="));

sources/import.queries.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
  *
  * Used to format the string ready for insertion in to the database
  */
+/**
+ * @param string $crLFReplacement
+ */
 function sanitiseString($str, $crLFReplacement) {
     $str = preg_replace('#[\r\n]#', $crLFReplacement, $str);
     $str = str_replace('\\', '\', $str);

sources/main.functions.php

Doc Comments +34 added lines, -1 removed lines

@@ -33,6 +33,9 @@ 
 use \Defuse\Crypto\Exception as Ex;
 
 //Generate N# of random bits for use as salt
+/**
+ * @param integer $n
+ */
 function getBits($n)
 {
     $str = '';
@@ -73,6 +76,7 @@ 
  * encryptOld()
  *
  * crypt a string
+ * @param string $text
  */
 function encryptOld($text, $personalSalt = "")
 {
@@ -149,6 +153,7 @@ 
  * encrypt()
  *
  * crypt a string
+ * @param string $decrypted
  */
 function encrypt($decrypted, $personalSalt = "")
 {
@@ -235,6 +240,7 @@ 
  * genHash()
  *
  * Generate a hash for user login
+ * @param string $password
  */
 function bCrypt($password, $cost)
 {
@@ -349,6 +355,10 @@ 
     return hex2bin($val);
 }
 
+/**
+ * @param string $ascii_key
+ * @param string $type
+ */
 function cryption($message, $ascii_key, $type) //defuse_crypto
 {
     // load PhpEncryption library
@@ -439,6 +449,9 @@ 
     return $protected_key_encoded;  // save this in user table
 }
 
+/**
+ * @param string $psk
+ */
 function defuse_validate_personal_key($psk, $protected_key_encoded) {
     require_once '../includes/libraries/Encryption/Encryption/Crypto.php';
     require_once '../includes/libraries/Encryption/Encryption/Encoding.php';
@@ -469,6 +482,8 @@ 
  * trimElement()
  *
  * trim a string depending on a specific string
+ * @param string $element
+ * @return string
  */
 function trimElement($chaine, $element)
 {
@@ -514,6 +529,7 @@ 
  * identifyUserRights()
  *
  * @return
+ * @param boolean $refresh
  */
 function identifyUserRights($groupesVisiblesUser, $groupesInterditsUser, $isAdmin, $idFonctions, $refresh)
 {
@@ -818,6 +834,7 @@ 
  * updateCacheTable()
  *
  * Update the CACHE table
+ * @param string $action
  */
 function updateCacheTable($action, $id = "")
 {
@@ -1190,7 +1207,7 @@ 
 /**
  * isUTF8()
  *
- * @return string is the string in UTF8 format.
+ * @return integer is the string in UTF8 format.
  */
 
 function isUTF8($string)
@@ -1215,6 +1232,9 @@ 
 * FUNCTION
 * permits to prepare data to be exchanged
 */
+/**
+ * @param string $type
+ */
 function prepareExchangedData($data, $type)
 {
     //load ClassLoader
@@ -1287,6 +1307,9 @@ 
 /*
 ** check table prefix in SQL query
 */
+/**
+ * @param string $table
+ */
 function prefix_table($table)
 {
     global $pre;
@@ -1325,6 +1348,9 @@ 
 /*
 * Send sysLOG message
 */
+/**
+ * @param string $message
+ */
 function send_syslog($message, $component = "teampass", $program = "php", $host , $port)
 {
     $sock = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
@@ -1340,6 +1366,9 @@ 
  * logEvents()
  *
  * permits to log events into DB
+ * @param string $type
+ * @param string $label
+ * @param string $field_1
  */
 function logEvents($type, $label, $who, $login="", $field_1 = NULL)
 {
@@ -1378,6 +1407,10 @@ 
     }
 }
 
+/**
+ * @param string $item
+ * @param string $action
+ */
 function logItems($id, $item, $id_user, $action, $login = "", $raison = NULL, $raison_iv = NULL, $encryption_type = "")
 {
     global $server, $user, $pass, $database, $pre, $port, $encoding;

install/libs/aesctr.php

Doc Comments +18 added lines, -5 removed lines

@@ -49,6 +49,10 @@ 
         return $output;
     }
 
+    /**
+     * @param integer $rnd
+     * @param integer $Nb
+     */
     private static function addRoundKey($state, $w, $rnd, $Nb)
     {
         // xor Round Key into state S [é5.1.4]
@@ -61,6 +65,9 @@ 
         return $state;
     }
 
+    /**
+     * @param integer $Nb
+     */
     private static function subBytes($s, $Nb)
     {
         // apply SBox to state S [é5.1.1]
@@ -73,6 +80,9 @@ 
         return $s;
     }
 
+    /**
+     * @param integer $Nb
+     */
     private static function shiftRows($s, $Nb)
     {
         // shift row r of state S left by r bytes [é5.1.2]
@@ -88,6 +98,9 @@ 
         return $s;  // see fp.gladman.plus.com/cryptography_technology/rijndael/aes.spec.311.pdf
     }
 
+    /**
+     * @param integer $Nb
+     */
     private static function mixColumns($s, $Nb)
     {
         // combine bytes of each col of state S [é5.1.3]
@@ -219,10 +232,10 @@ 
     *
     * Unicode multi-byte character safe
     *
-    * @param plaintext source text to be encrypted
+    * @param plaintext string text to be encrypted
     * @param password  the password to use to generate a key
-    * @param nBits     number of bits to be used in the key (128, 192, or 256)
-    * @return          encrypted text
+    * @param nBits     integer of bits to be used in the key (128, 192, or 256)
+    * @return          string text
     */
     public static function encrypt($plaintext, $password, $nBits)
     {
@@ -302,8 +315,8 @@ 
     *
     * @param ciphertext source text to be decrypted
     * @param password   the password to use to generate a key
-    * @param nBits      number of bits to be used in the key (128, 192, or 256)
-    * @return           decrypted text
+    * @param nBits      integer of bits to be used in the key (128, 192, or 256)
+    * @return           string text
     */
     public static function decrypt($ciphertext, $password, $nBits)
     {

install/upgrade_ajax.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 ################
 ## Function permits to get the value from a line
 ################
+/**
+ * @param string $val
+ */
 function getSettingValue($val)
 {
     $val = trim(strstr($val, "="));