Lithnet Password Protection for AD
Request a quote for supportDownloads
v1.1
v1.1
  • Home
    • About Lithnet Password Protection
  • Setup
    • Getting started
    • Downloads
    • Setup requirements
    • Installation
    • Creating a new store
    • Load compromised passwords into the store
    • Configure group policy
    • Testing the password filter
  • Auditing
    • Audit existing passwords
  • Help & Support
    • Testing the password filter
    • Troubleshooting steps
    • Frequently asked questions
    • Getting support
    • Change log
  • Advanced Help
    • Powershell reference
      • Add-BannedWord
      • Add-CompromisedPassword
      • Get-PasswordFilterConfig
      • Get-PasswordFilterPolicy
      • Get-PasswordFilterResult
      • Import-BannedWordHashes
      • Import-BannedWords
      • Import-CompromisedPasswordHashes
      • Import-CompromisedPasswords
      • Open-Store
      • Remove-BannedWord
      • Remove-CompromisedPassword
      • Set-PasswordFilterConfig
      • Sync-HashesFromHibp
      • Test-IsADUserPasswordCompromised
      • Test-IsBannedWord
      • Test-IsCompromisedPassword
    • Normalization Rules
    • Event logging and reporting
    • Configuring a length based complexity policy
    • Configuring a points based complexity policy
    • Understanding the store
Powered by GitBook
On this page
  • SYNOPSIS
  • SYNTAX
  • String (Default)
  • Hash
  • SecureString
  • DESCRIPTION
  • EXAMPLES
  • Example 1
  • PARAMETERS
  • -Hash
  • -SecureString
  • -Value
  • CommonParameters
  • INPUTS
  • System.String
  • System.Byte[]
  • System.Security.SecureString
  • OUTPUTS
  • System.Object
  • NOTES
  • RELATED LINKS
  1. Advanced Help
  2. Powershell reference

Test-IsBannedWord

SYNOPSIS

Checks to see if a string matches a value in the banned word store

SYNTAX

String (Default)

Test-IsBannedWord [-Value] <String> [<CommonParameters>]

Hash

Test-IsBannedWord [-Hash] <Byte[]> [<CommonParameters>]

SecureString

Test-IsBannedWord [-SecureString] <SecureString> [<CommonParameters>]

DESCRIPTION

The Test-IsBannedWord cmdlet checks to see if a specified string matches a value in the banned word store. Normalization rules are applied to the string and the resulting value is checked against the store.

EXAMPLES

Example 1

# Add a word to the store
PS C:\> Add-BannedWord -Value password

# Test the exact word and ensure it is found
PS C:\> Test-IsBannedWord -Value password
True

# Test a modification of the banned word, and ensure it is found
PS C:\> Test-IsBannedWord -Value P@ssw0rd!
True

The example shown above adds a word to the banned word store, and then tests the exact word and a modified version of the word. The modified version of the word is found because the normalization rules applied to the word before it is checked against the store.

PARAMETERS

-Hash

A binary hash to test. A hash cannot be normalized, so it is tested as-is.

Type: Byte[]
Parameter Sets: Hash
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SecureString

The string to test as a secure string

Type: SecureString
Parameter Sets: SecureString
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Value

The string to test as a plain-text string

Type: String
Parameter Sets: String
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

INPUTS

System.String

System.Byte[]

System.Security.SecureString

OUTPUTS

System.Object

NOTES

RELATED LINKS

PreviousTest-IsADUserPasswordCompromisedNextTest-IsCompromisedPassword

Last updated 2 months ago

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see .

about_CommonParameters
Normalization rules