/usr/share/doc/libjuce/apiref/classKeyGeneration.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: KeyGeneration Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classKeyGeneration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KeyGeneration Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Contains static utilities for generating key-files that can be unlocked by the <a class="el" href="classOnlineUnlockStatus.html" title="A base class for online unlocking systems. ">OnlineUnlockStatus</a> class.
<a href="classKeyGeneration.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a8554134a97627178203b3f288c90eee0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classString.html">String</a> <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyGeneration.html#a8554134a97627178203b3f288c90eee0">generateKeyFile</a> (const <a class="el" href="classString.html">String</a> &appName, const <a class="el" href="classString.html">String</a> &userEmail, const <a class="el" href="classString.html">String</a> &userName, const <a class="el" href="classString.html">String</a> &machineNumbers, const <a class="el" href="classRSAKey.html">RSAKey</a> &privateKey)</td></tr>
<tr class="memdesc:a8554134a97627178203b3f288c90eee0"><td class="mdescLeft"> </td><td class="mdescRight">Generates the content of a key-file which can be sent to a user's machine to unlock a product. <a href="#a8554134a97627178203b3f288c90eee0">More...</a><br /></td></tr>
<tr class="separator:a8554134a97627178203b3f288c90eee0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5652ee792c95a217a4394ce13fbf93e2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classString.html">String</a> <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyGeneration.html#a5652ee792c95a217a4394ce13fbf93e2">generateExpiringKeyFile</a> (const <a class="el" href="classString.html">String</a> &appName, const <a class="el" href="classString.html">String</a> &userEmail, const <a class="el" href="classString.html">String</a> &userName, const <a class="el" href="classString.html">String</a> &machineNumbers, const <a class="el" href="classTime.html">Time</a> expiryTime, const <a class="el" href="classRSAKey.html">RSAKey</a> &privateKey)</td></tr>
<tr class="memdesc:a5652ee792c95a217a4394ce13fbf93e2"><td class="mdescLeft"> </td><td class="mdescRight">Similar to the above key file generation method but with an expiry time. <a href="#a5652ee792c95a217a4394ce13fbf93e2">More...</a><br /></td></tr>
<tr class="separator:a5652ee792c95a217a4394ce13fbf93e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a608c4ffe01796eba24a5ab563b5d488e"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyGeneration.html#a608c4ffe01796eba24a5ab563b5d488e">keyGenerationAppMain</a> (int argc, char *argv[])</td></tr>
<tr class="memdesc:a608c4ffe01796eba24a5ab563b5d488e"><td class="mdescLeft"> </td><td class="mdescRight">This is a simple implementation of a key-generator that you could easily wrap in a command-line main() function for use on your server. <a href="#a608c4ffe01796eba24a5ab563b5d488e">More...</a><br /></td></tr>
<tr class="separator:a608c4ffe01796eba24a5ab563b5d488e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains static utilities for generating key-files that can be unlocked by the <a class="el" href="classOnlineUnlockStatus.html" title="A base class for online unlocking systems. ">OnlineUnlockStatus</a> class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8554134a97627178203b3f288c90eee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8554134a97627178203b3f288c90eee0">§ </a></span>generateKeyFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classString.html">String</a> <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> KeyGeneration::generateKeyFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>appName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>userEmail</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>userName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>machineNumbers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRSAKey.html">RSAKey</a> & </td>
<td class="paramname"><em>privateKey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates the content of a key-file which can be sent to a user's machine to unlock a product. </p>
<p>The returned value is a block of text containing an RSA-encoded block, followed by some human-readable details. If you pass this block of text to <a class="el" href="classOnlineUnlockStatus.html#ac0763c3b120f1b173c46dc5611112da3" title="Attempts to perform an unlock using a block of key-file data provided. ">OnlineUnlockStatus::applyKeyFile()</a>, it will decrypt it, and if the key matches and the machine numbers match, it will unlock that machine.</p>
<p>Typically the way you'd use this on a server would be to build a small executable that simply calls this method and prints the result, so that the webserver can use this as a reply to the product's auto-registration mechanism. The <a class="el" href="classKeyGeneration.html#a608c4ffe01796eba24a5ab563b5d488e" title="This is a simple implementation of a key-generator that you could easily wrap in a command-line main(...">keyGenerationAppMain()</a> function is an example of how to build such a function.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOnlineUnlockStatus.html" title="A base class for online unlocking systems. ">OnlineUnlockStatus</a> </dd></dl>
</div>
</div>
<a id="a5652ee792c95a217a4394ce13fbf93e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5652ee792c95a217a4394ce13fbf93e2">§ </a></span>generateExpiringKeyFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classString.html">String</a> <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> KeyGeneration::generateExpiringKeyFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>appName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>userEmail</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>userName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>machineNumbers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTime.html">Time</a> </td>
<td class="paramname"><em>expiryTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRSAKey.html">RSAKey</a> & </td>
<td class="paramname"><em>privateKey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Similar to the above key file generation method but with an expiry time. </p>
<p>You must supply a <a class="el" href="classTime.html" title="Holds an absolute date and time. ">Time</a> after which this key file should no longer be considered as active.</p>
<p>N.B. when an app is unlocked with an expiring key file, <a class="el" href="classOnlineUnlockStatus.html#ad5b13f8fc564b0540033b614db089169" title="Returns true if the product has been successfully authorised for this machine. ">OnlineUnlockStatus::isUnlocked</a> will still return false. You must then check <a class="el" href="classOnlineUnlockStatus.html#a3a604280c13257166c476b696fea66e1" title="Returns the Time when the keyfile expires. ">OnlineUnlockStatus::getExpiryTime</a> to see if this expiring key file is still in date and act accordingly.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOnlineUnlockStatus.html" title="A base class for online unlocking systems. ">OnlineUnlockStatus</a> </dd></dl>
</div>
</div>
<a id="a608c4ffe01796eba24a5ab563b5d488e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a608c4ffe01796eba24a5ab563b5d488e">§ </a></span>keyGenerationAppMain()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int KeyGeneration::keyGenerationAppMain </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is a simple implementation of a key-generator that you could easily wrap in a command-line main() function for use on your server. </p>
<p>So for example you might use this in a command line app called "unlocker" and then call it like this:</p>
<p>unlocker MyGreatApp Joe_Bloggs <a href="#" onclick="location.href='mai'+'lto:'+'joe'+'bl'+'ogg'+'s@'+'foo'+'ba'+'r.c'+'om'; return false;">joebl<span style="display: none;">.nosp@m.</span>oggs<span style="display: none;">.nosp@m.</span>@foob<span style="display: none;">.nosp@m.</span>ar.c<span style="display: none;">.nosp@m.</span>om</a> 1234abcd,95432ff 22d9aec92d986dd1,923ad49e9e7ff294c </p>
<p>References <a class="el" href="classStringArray.html#ac0e8e4b0c3d3345b9ee429c00571bb6e">StringArray::add()</a>, and <a class="el" href="classStringArray.html#af1eb48dd90938eb34d9f43cf7d81510b">StringArray::size()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__KeyFileGeneration_8h.html">juce_KeyFileGeneration.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|