Plan/all/com/djrapitops/plan/utilities/PassEncryptUtil.html

335 lines
12 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>PassEncryptUtil (Plan 5.4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
2019-08-05 11:13:19 +02:00
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
2019-08-05 11:13:19 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PassEncryptUtil (Plan 5.4-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.utilities</a></div>
2019-08-05 11:13:19 +02:00
<h2 title="Class PassEncryptUtil" class="title">Class PassEncryptUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.utilities.PassEncryptUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">PassEncryptUtil</span>
extends java.lang.Object</pre>
<div class="block">Password Encryption utility.
<p>
https://github.com/defuse/password-hashing/blob/master/PasswordStorage.java</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PassEncryptUtil.CannotPerformOperationException.html" title="class in com.djrapitops.plan.utilities">PassEncryptUtil.CannotPerformOperationException</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PassEncryptUtil.InvalidHashException.html" title="class in com.djrapitops.plan.utilities">PassEncryptUtil.InvalidHashException</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createHash(java.lang.String)">createHash</a></span>&#8203;(java.lang.String&nbsp;password)</code></th>
<td class="colLast">
2020-06-21 19:24:04 +02:00
<div class="block">Create a hash of password + salt.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifyPassword(java.lang.String,java.lang.String)">verifyPassword</a></span>&#8203;(java.lang.String&nbsp;password,
java.lang.String&nbsp;correctHash)</code></th>
<td class="colLast">
2020-06-21 19:24:04 +02:00
<div class="block">Verify that a password matches a hash.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="createHash(java.lang.String)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createHash</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;createHash&#8203;(java.lang.String&nbsp;password)</pre>
2020-06-21 19:24:04 +02:00
<div class="block">Create a hash of password + salt.</div>
2019-08-05 11:13:19 +02:00
<dl>
2020-06-21 19:24:04 +02:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - Password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Hash + salt</dd>
2019-08-05 11:13:19 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PassEncryptUtil.CannotPerformOperationException.html" title="class in com.djrapitops.plan.utilities">PassEncryptUtil.CannotPerformOperationException</a></code> - If the hash creation fails</dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
<a id="verifyPassword(java.lang.String,java.lang.String)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>verifyPassword</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;verifyPassword&#8203;(java.lang.String&nbsp;password,
2020-06-21 19:24:04 +02:00
java.lang.String&nbsp;correctHash)</pre>
<div class="block">Verify that a password matches a hash.</div>
2019-08-05 11:13:19 +02:00
<dl>
2020-06-21 19:24:04 +02:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - Password</dd>
<dd><code>correctHash</code> - hash created with <a href="#createHash(java.lang.String)"><code>createHash(String)</code></a></dd>
2020-06-21 19:24:04 +02:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if match</dd>
2019-08-05 11:13:19 +02:00
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PassEncryptUtil.CannotPerformOperationException.html" title="class in com.djrapitops.plan.utilities">PassEncryptUtil.CannotPerformOperationException</a></code> - If hashing fails</dd>
<dd><code><a href="PassEncryptUtil.InvalidHashException.html" title="class in com.djrapitops.plan.utilities">PassEncryptUtil.InvalidHashException</a></code> - If the hash is missing details.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
</div>
</main>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2019-08-05 11:13:19 +02:00
</body>
</html>