CapyKit/Docs/api/CapyKit.IPasswordAlgorithm.yml

### YamlMime:ManagedReference
items:
- uid: CapyKit.IPasswordAlgorithm
  commentId: T:CapyKit.IPasswordAlgorithm
  id: IPasswordAlgorithm
  parent: CapyKit
  children:
  - CapyKit.IPasswordAlgorithm.AlgorithmName
  - CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
  - CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
  langs:
  - csharp
  - vb
  name: IPasswordAlgorithm
  nameWithType: IPasswordAlgorithm
  fullName: CapyKit.IPasswordAlgorithm
  type: Interface
  source:
    remote:
      path: CapyKit/Password.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: IPasswordAlgorithm
    path: ../CapyKit/Password.cs
    startLine: 121
  assemblies:
  - CapyKit
  namespace: CapyKit
  summary: Defines the contract for password encryption algorithms.
  example: []
  syntax:
    content: public interface IPasswordAlgorithm
    content.vb: Public Interface IPasswordAlgorithm
  derivedClasses:
  - CapyKit.Pbkdf2Algorithm
  extensionMethods:
  - CapyKit.IPasswordAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm)
  - System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.IPasswordAlgorithm.AlgorithmName
  commentId: P:CapyKit.IPasswordAlgorithm.AlgorithmName
  id: AlgorithmName
  parent: CapyKit.IPasswordAlgorithm
  langs:
  - csharp
  - vb
  name: AlgorithmName
  nameWithType: IPasswordAlgorithm.AlgorithmName
  fullName: CapyKit.IPasswordAlgorithm.AlgorithmName
  type: Property
  source:
    remote:
      path: CapyKit/Password.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: AlgorithmName
    path: ../CapyKit/Password.cs
    startLine: 128
  assemblies:
  - CapyKit
  namespace: CapyKit
  summary: Gets the name of the algorithm.
  example: []
  syntax:
    content: string AlgorithmName { get; }
    parameters: []
    return:
      type: System.String
    content.vb: ReadOnly Property AlgorithmName As String
  overload: CapyKit.IPasswordAlgorithm.AlgorithmName*
- uid: CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
  commentId: M:CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
  id: Encrypt(System.String,System.Object[])
  parent: CapyKit.IPasswordAlgorithm
  langs:
  - csharp
  - vb
  name: Encrypt(string, params object[])
  nameWithType: IPasswordAlgorithm.Encrypt(string, params object[])
  fullName: CapyKit.IPasswordAlgorithm.Encrypt(string, params object[])
  type: Method
  source:
    remote:
      path: CapyKit/Password.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: Encrypt
    path: ../CapyKit/Password.cs
    startLine: 140
  assemblies:
  - CapyKit
  namespace: CapyKit
  summary: Encrypts the given password using a defined algorithm.
  example: []
  syntax:
    content: byte[] Encrypt(string password, params object[] args)
    parameters:
    - id: password
      type: System.String
      description: The plaintext password.
    - id: args
      type: System.Object[]
      description: Additional arguments for the encryption process, such as salt and length.
    return:
      type: System.Byte[]
      description: A byte array with the hashed <code class="paramref">password</code>.
    content.vb: Function Encrypt(password As String, ParamArray args As Object()) As Byte()
  overload: CapyKit.IPasswordAlgorithm.Encrypt*
  nameWithType.vb: IPasswordAlgorithm.Encrypt(String, ParamArray Object())
  fullName.vb: CapyKit.IPasswordAlgorithm.Encrypt(String, ParamArray Object())
  name.vb: Encrypt(String, ParamArray Object())
- uid: CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
  commentId: M:CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
  id: Compare(System.String,System.Byte[],System.Object[])
  parent: CapyKit.IPasswordAlgorithm
  langs:
  - csharp
  - vb
  name: Compare(string, byte[], params object[])
  nameWithType: IPasswordAlgorithm.Compare(string, byte[], params object[])
  fullName: CapyKit.IPasswordAlgorithm.Compare(string, byte[], params object[])
  type: Method
  source:
    remote:
      path: CapyKit/Password.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: Compare
    path: ../CapyKit/Password.cs
    startLine: 154
  assemblies:
  - CapyKit
  namespace: CapyKit
  summary: Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
  example: []
  syntax:
    content: bool Compare(string password, byte[] encryptedValue, params object[] args)
    parameters:
    - id: password
      type: System.String
      description: The plaintext password to compare.
    - id: encryptedValue
      type: System.Byte[]
      description: The encrypted value to compare against.
    - id: args
      type: System.Object[]
      description: Additional arguments for the encryption process, such as salt and length.
    return:
      type: System.Boolean
      description: >-
        True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,

        false if they are different.
    content.vb: Function Compare(password As String, encryptedValue As Byte(), ParamArray args As Object()) As Boolean
  overload: CapyKit.IPasswordAlgorithm.Compare*
  nameWithType.vb: IPasswordAlgorithm.Compare(String, Byte(), ParamArray Object())
  fullName.vb: CapyKit.IPasswordAlgorithm.Compare(String, Byte(), ParamArray Object())
  name.vb: Compare(String, Byte(), ParamArray Object())
references:
- uid: CapyKit
  commentId: N:CapyKit
  href: CapyKit.html
  name: CapyKit
  nameWithType: CapyKit
  fullName: CapyKit
- uid: CapyKit.IPasswordAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm)
  commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
  parent: CapyKit.Extensions.ObjectExtensions
  definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
  href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  name: UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)
  nameWithType: ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)
  fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.IPasswordAlgorithm>(CapyKit.IPasswordAlgorithm, CapyKit.IPasswordAlgorithm)
  nameWithType.vb: ObjectExtensions.UpdateProperties(Of IPasswordAlgorithm)(IPasswordAlgorithm, IPasswordAlgorithm)
  fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.IPasswordAlgorithm)(CapyKit.IPasswordAlgorithm, CapyKit.IPasswordAlgorithm)
  name.vb: UpdateProperties(Of IPasswordAlgorithm)(IPasswordAlgorithm, IPasswordAlgorithm)
  spec.csharp:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm,CapyKit.IPasswordAlgorithm)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  - name: <
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: '>'
  - name: (
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: ','
  - name: " "
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: )
  spec.vb:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm,CapyKit.IPasswordAlgorithm)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  - name: (
  - name: Of
  - name: " "
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: )
  - name: (
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: ','
  - name: " "
  - uid: CapyKit.IPasswordAlgorithm
    name: IPasswordAlgorithm
    href: CapyKit.IPasswordAlgorithm.html
  - name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
  commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
  parent: CapyKit.Extensions.ObjectExtensions
  definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
  href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  name: UpdateProperties(object, object)
  nameWithType: ObjectExtensions.UpdateProperties(object, object)
  fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
  nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
  fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
  name.vb: UpdateProperties(Object, Object)
  spec.csharp:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
  commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
  href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  name: UpdateProperties<T>(T, T)
  nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
  fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
  nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
  fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
  name.vb: UpdateProperties(Of T)(T, T)
  spec.csharp:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  - name: <
  - name: T
  - name: '>'
  - name: (
  - name: T
  - name: ','
  - name: " "
  - name: T
  - name: )
  spec.vb:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
  - name: (
  - name: Of
  - name: " "
  - name: T
  - name: )
  - name: (
  - name: T
  - name: ','
  - name: " "
  - name: T
  - name: )
- uid: CapyKit.Extensions.ObjectExtensions
  commentId: T:CapyKit.Extensions.ObjectExtensions
  parent: CapyKit.Extensions
  href: CapyKit.Extensions.ObjectExtensions.html
  name: ObjectExtensions
  nameWithType: ObjectExtensions
  fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
  commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
  isExternal: true
  href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  name: UpdateProperties(object, object)
  nameWithType: ObjectExtensions.UpdateProperties(object, object)
  fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
  nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
  fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
  name.vb: UpdateProperties(Object, Object)
  spec.csharp:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
    name: UpdateProperties
    href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: CapyKit.Extensions
  commentId: N:CapyKit.Extensions
  href: CapyKit.html
  name: CapyKit.Extensions
  nameWithType: CapyKit.Extensions
  fullName: CapyKit.Extensions
  spec.csharp:
  - uid: CapyKit
    name: CapyKit
    href: CapyKit.html
  - name: .
  - uid: CapyKit.Extensions
    name: Extensions
    href: CapyKit.Extensions.html
  spec.vb:
  - uid: CapyKit
    name: CapyKit
    href: CapyKit.html
  - name: .
  - uid: CapyKit.Extensions
    name: Extensions
    href: CapyKit.Extensions.html
- uid: CapyKit.IPasswordAlgorithm.AlgorithmName*
  commentId: Overload:CapyKit.IPasswordAlgorithm.AlgorithmName
  href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_AlgorithmName
  name: AlgorithmName
  nameWithType: IPasswordAlgorithm.AlgorithmName
  fullName: CapyKit.IPasswordAlgorithm.AlgorithmName
- uid: System.String
  commentId: T:System.String
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.string
  name: string
  nameWithType: string
  fullName: string
  nameWithType.vb: String
  fullName.vb: String
  name.vb: String
- uid: System
  commentId: N:System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system
  name: System
  nameWithType: System
  fullName: System
- uid: CapyKit.IPasswordAlgorithm.Encrypt*
  commentId: Overload:CapyKit.IPasswordAlgorithm.Encrypt
  href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___
  name: Encrypt
  nameWithType: IPasswordAlgorithm.Encrypt
  fullName: CapyKit.IPasswordAlgorithm.Encrypt
- uid: System.Object[]
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object
  name: object[]
  nameWithType: object[]
  fullName: object[]
  nameWithType.vb: Object()
  fullName.vb: Object()
  name.vb: Object()
  spec.csharp:
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: '['
  - name: ']'
  spec.vb:
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: (
  - name: )
- uid: System.Byte[]
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.byte
  name: byte[]
  nameWithType: byte[]
  fullName: byte[]
  nameWithType.vb: Byte()
  fullName.vb: Byte()
  name.vb: Byte()
  spec.csharp:
  - uid: System.Byte
    name: byte
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.byte
  - name: '['
  - name: ']'
  spec.vb:
  - uid: System.Byte
    name: Byte
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.byte
  - name: (
  - name: )
- uid: CapyKit.IPasswordAlgorithm.Compare*
  commentId: Overload:CapyKit.IPasswordAlgorithm.Compare
  href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___
  name: Compare
  nameWithType: IPasswordAlgorithm.Compare
  fullName: CapyKit.IPasswordAlgorithm.Compare
- uid: System.Boolean
  commentId: T:System.Boolean
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.boolean
  name: bool
  nameWithType: bool
  fullName: bool
  nameWithType.vb: Boolean
  fullName.vb: Boolean
  name.vb: Boolean