> For the complete documentation index, see [llms.txt](https://docs.lithnet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lithnet.io/password-protection/advanced-help/powershell-reference/test-iscompromisedpassword.md).

# Test-IsCompromisedPassword

## SYNOPSIS

Checks if a password is in the compromised password store

## SYNTAX

### String (Default)

```
Test-IsCompromisedPassword [-Value] <String> [-Normalize] [<CommonParameters>]
```

### Hash

```
Test-IsCompromisedPassword [-Hash] <Byte[]> [<CommonParameters>]
```

### SecureString

```
Test-IsCompromisedPassword [-SecureString] <SecureString> [-Normalize] [<CommonParameters>]
```

## DESCRIPTION

The Test-IsCompromisedPassword cmdlet checks to see if a specified string matches a value in the compromised password store.

## EXAMPLES

### Example 1

```powershell
# Add a password to the store
PS> Add-CompromisedPassword -Value password!!!

# Test the password and ensure it is found
PS> Test-IsCompromisedPassword -Value password!!!
True
```

This example adds a password to the compromised password store, and then tests it to ensure it is found

## PARAMETERS

### -Hash

A binary hash to test

```yaml
Type: Byte[]
Parameter Sets: Hash
Aliases:

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

### -Normalize

Normalizes the password before testing it against the store

```yaml
Type: SwitchParameter
Parameter Sets: String, SecureString
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SecureString

The string to test as a SecureString.

```yaml
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.

```yaml
Type: String
Parameter Sets: String
Aliases:

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

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### System.String

### System.Byte\[]

### System.Security.SecureString

## OUTPUTS

### System.Object

The cmdlet returns a boolean value indicating whether the input string or hash matches a value in the compromised password store.

## NOTES

## RELATED LINKS


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lithnet.io/password-protection/advanced-help/powershell-reference/test-iscompromisedpassword.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
