CodeGlyphX logo
CodeGlyphX

API Reference

Class

Otp (CodeGlyphX)

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers static

Simple OTP helpers with fluent and static APIs.

Inheritance

  • Object
  • Otp

Methods

public static HotpBuilder Hotp(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null) #
Returns: HotpBuilder

Starts a fluent HOTP builder.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
public static String HotpHtml(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: String

Renders a HOTP QR as HTML from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
public static Byte[] HotpJpeg(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Byte[]

Renders a HOTP QR as JPEG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
public static Byte[] HotpPng(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Byte[]

Renders a HOTP QR as PNG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
public static String HotpSvg(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: String

Renders a HOTP QR as SVG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
HotpUri 2 overloads
public static String HotpUri(String issuer, String account, Byte[] secret, Int64 counter, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: String

Builds a HOTP URI from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
HotpUri(System.String issuer, System.String account, System.Byte[] secret, System.Int64 counter, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits) #

Builds a HOTP URI from raw secret bytes.

Parameters

issuer System.String required
account System.String required
secret System.Byte[] required
counter System.Int64 required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
public static Byte[] HotpWebp(String issuer, String account, String secretBase32, Int64 counter, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Byte[]

Renders a HOTP QR as WebP from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
public static String SaveHotp(String issuer, String account, String secretBase32, Int64 counter, String path, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, String title = null) #
Returns: String

Saves a HOTP QR based on file extension (.png/.webp/.svg/.html/.jpg/.bmp/.pdf/.eps). Defaults to PNG when no extension is provided.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
title System.String = null optionalposition: 8
SaveHotpHtml 2 overloads
public static Void SaveHotpHtml(String issuer, String account, String secretBase32, Int64 counter, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, String title = null) #
Returns: Void

Saves a HOTP HTML to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
title System.String = null optionalposition: 8
SaveHotpHtml(System.String issuer, System.String account, System.String secretBase32, System.Int64 counter, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.String title) #

Saves a HOTP HTML to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
counter System.Int64 required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
title System.String required
SaveHotpJpeg 2 overloads
public static Void SaveHotpJpeg(String issuer, String account, String secretBase32, Int64 counter, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Void

Saves a HOTP JPEG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
SaveHotpJpeg(System.String issuer, System.String account, System.String secretBase32, System.Int64 counter, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits) #

Saves a HOTP JPEG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
counter System.Int64 required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
SaveHotpPng 2 overloads
public static Void SaveHotpPng(String issuer, String account, String secretBase32, Int64 counter, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Void

Saves a HOTP PNG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
SaveHotpPng(System.String issuer, System.String account, System.String secretBase32, System.Int64 counter, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits) #

Saves a HOTP PNG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
counter System.Int64 required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
SaveHotpSvg 2 overloads
public static Void SaveHotpSvg(String issuer, String account, String secretBase32, Int64 counter, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Void

Saves a HOTP SVG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
SaveHotpSvg(System.String issuer, System.String account, System.String secretBase32, System.Int64 counter, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits) #

Saves a HOTP SVG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
counter System.Int64 required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
SaveHotpWebp 2 overloads
public static Void SaveHotpWebp(String issuer, String account, String secretBase32, Int64 counter, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6) #
Returns: Void

Saves a HOTP WebP to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
counter System.Int64 requiredposition: 3
path System.String requiredposition: 4
options CodeGlyphX.QrEasyOptions = null optionalposition: 5
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 6
digits System.Int32 = 6 optionalposition: 7
SaveHotpWebp(System.String issuer, System.String account, System.String secretBase32, System.Int64 counter, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits) #

Saves a HOTP WebP to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
counter System.Int64 required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
public static String SaveTotp(String issuer, String account, String secretBase32, String path, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30, String title = null) #
Returns: String

Saves a TOTP QR based on file extension (.png/.webp/.svg/.html/.jpg/.bmp/.pdf/.eps). Defaults to PNG when no extension is provided.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
title System.String = null optionalposition: 8
SaveTotpHtml 2 overloads
public static Void SaveTotpHtml(String issuer, String account, String secretBase32, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30, String title = null) #
Returns: Void

Saves a TOTP HTML to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
title System.String = null optionalposition: 8
SaveTotpHtml(System.String issuer, System.String account, System.String secretBase32, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period, System.String title) #

Saves a TOTP HTML to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
title System.String required
SaveTotpJpeg 2 overloads
public static Void SaveTotpJpeg(String issuer, String account, String secretBase32, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Void

Saves a TOTP JPEG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
SaveTotpJpeg(System.String issuer, System.String account, System.String secretBase32, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period) #

Saves a TOTP JPEG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
SaveTotpPng 2 overloads
public static Void SaveTotpPng(String issuer, String account, String secretBase32, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Void

Saves a TOTP PNG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
SaveTotpPng(System.String issuer, System.String account, System.String secretBase32, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period) #

Saves a TOTP PNG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
SaveTotpSvg 2 overloads
public static Void SaveTotpSvg(String issuer, String account, String secretBase32, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Void

Saves a TOTP SVG to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
SaveTotpSvg(System.String issuer, System.String account, System.String secretBase32, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period) #

Saves a TOTP SVG to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
SaveTotpWebp 2 overloads
public static Void SaveTotpWebp(String issuer, String account, String secretBase32, Stream stream, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Void

Saves a TOTP WebP to a file.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.QrEasyOptions = null optionalposition: 4
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 5
digits System.Int32 = 6 optionalposition: 6
period System.Int32 = 30 optionalposition: 7
SaveTotpWebp(System.String issuer, System.String account, System.String secretBase32, System.IO.Stream stream, CodeGlyphX.QrEasyOptions options, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period) #

Saves a TOTP WebP to a stream.

Parameters

issuer System.String required
account System.String required
secretBase32 System.String required
stream System.IO.Stream required
options CodeGlyphX.QrEasyOptions required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
public static TotpBuilder Totp(String issuer, String account, String secretBase32, QrEasyOptions options = null) #
Returns: TotpBuilder

Starts a fluent TOTP builder.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
public static String TotpHtml(String issuer, String account, String secretBase32, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: String

Renders a TOTP QR as HTML from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
period System.Int32 = 30 optionalposition: 6
public static Byte[] TotpJpeg(String issuer, String account, String secretBase32, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Byte[]

Renders a TOTP QR as JPEG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
period System.Int32 = 30 optionalposition: 6
public static Byte[] TotpPng(String issuer, String account, String secretBase32, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Byte[]

Renders a TOTP QR as PNG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
period System.Int32 = 30 optionalposition: 6
public static String TotpSvg(String issuer, String account, String secretBase32, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: String

Renders a TOTP QR as SVG from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
period System.Int32 = 30 optionalposition: 6
TotpUri 2 overloads
public static String TotpUri(String issuer, String account, Byte[] secret, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: String

Builds a TOTP URI from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 3
digits System.Int32 = 6 optionalposition: 4
period System.Int32 = 30 optionalposition: 5
TotpUri(System.String issuer, System.String account, System.Byte[] secret, CodeGlyphX.OtpAlgorithm alg, System.Int32 digits, System.Int32 period) #

Builds a TOTP URI from raw secret bytes.

Parameters

issuer System.String required
account System.String required
secret System.Byte[] required
alg CodeGlyphX.OtpAlgorithm required
digits System.Int32 required
period System.Int32 required
public static Byte[] TotpWebp(String issuer, String account, String secretBase32, QrEasyOptions options = null, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30) #
Returns: Byte[]

Renders a TOTP QR as WebP from a Base32 secret.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secretBase32 System.String requiredposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
period System.Int32 = 30 optionalposition: 6