Skip to content

Commit 010488c

Browse files
committed
Python/JS: Update QLDoc for crypto algorithms before sharing
1 parent 646ea55 commit 010488c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

python/ql/src/semmle/crypto/Crypto.qll

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
2-
* Provides classes for modeling cryptographic libraries.
2+
* Provides classes modeling cryptographic algorithms, separated into strong and weak variants.
3+
*
4+
* The classification into strong and weak are based on Wikipedia, OWASP and google (2017).
35
*/
46

57
/**
@@ -110,7 +112,7 @@ abstract class CryptographicAlgorithm extends TCryptographicAlgorithm {
110112
string toString() { result = getName() }
111113

112114
/**
113-
* Gets the name of this algorithm.
115+
* Gets the normalized name of this algorithm (upper-case, no spaces, dashes or underscores).
114116
*/
115117
abstract string getName();
116118

0 commit comments

Comments
 (0)