{
    "content": [
        {
            "type": "text",
            "text": "# cryptsetup-ssh (man)\n\n## NAME\n\ncryptsetup-ssh - manage LUKS2 SSH token\n\n## SYNOPSIS\n\ncryptsetup-ssh <options> <action> <action args>\n\n## DESCRIPTION\n\nExperimental  cryptsetup  plugin  for  unlocking LUKS2 devices with token connected to an SSH\nserver.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (1 subsections)\n- **OPTIONS** (4 subsections)\n- **NOTES**\n- **REPORTING BUGS**\n- **COPYRIGHT**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "cryptsetup-ssh",
        "section": "",
        "mode": "man",
        "summary": "cryptsetup-ssh - manage LUKS2 SSH token",
        "synopsis": "cryptsetup-ssh <options> <action> <action args>",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "",
                "long": "--debug",
                "arg": null,
                "description": "Show debug messages"
            },
            {
                "flag": "",
                "long": "--debug-json",
                "arg": null,
                "description": "Show debug messages including JSON metadata"
            },
            {
                "flag": "-v",
                "long": "--verbose",
                "arg": null,
                "description": "Shows more detailed error messages -?, --help Show help"
            },
            {
                "flag": "-V",
                "long": "--version",
                "arg": null,
                "description": "Print program version"
            }
        ],
        "examples": [],
        "see_also": [
            {
                "name": "CRYPTSETUP-SSH",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/CRYPTSETUP-SSH/8/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 7,
                "subsections": [
                    {
                        "name": "Add operation",
                        "lines": 28
                    }
                ]
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "--debug",
                        "lines": 2,
                        "long": "--debug"
                    },
                    {
                        "name": "--debug-json",
                        "lines": 2,
                        "long": "--debug-json"
                    },
                    {
                        "name": "-v --verbose",
                        "lines": 5,
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "-V --version",
                        "lines": 2,
                        "flag": "-V",
                        "long": "--version"
                    }
                ]
            },
            {
                "name": "NOTES",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "REPORTING BUGS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "cryptsetup-ssh - manage LUKS2 SSH token\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "cryptsetup-ssh <options> <action> <action args>\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Experimental  cryptsetup  plugin  for  unlocking LUKS2 devices with token connected to an SSH\nserver.\n\nThis plugin currently allows only adding a token to an existing key slot,  see  cryptsetup(8)\nfor instruction on how to remove, import or export the token.\n\n",
                "subsections": [
                    {
                        "name": "Add operation",
                        "content": "add <options> <device>\n\nAdds the SSH token to <device>.\n\nSpecified  SSH  server must contain a key file on the specified path with a passphrase\nfor an existing key slot on the device.  Provided credentials will be used  by  crypt‐\nsetup to get the password when opening the device using the token.\n\n--ssh-server,  --ssh-user,  --ssh-keypath  and --ssh-path are required for this opera‐\ntion.\n\n\n--key-slot=NUM\nKeyslot to assign the token to. If not specified, the token will be  assigned  to  the\nfirst key slot matching provided passphrase.\n\n--ssh-keypath=STRING\nPath to the SSH key for connecting to the remote server.\n\n--ssh-path=STRING\nPath to the key file on the remote server.\n\n--ssh-server=STRING\nIP address/URL of the remote server for this token.\n\n--ssh-user=STRING\nUsername used for the remote server.\n"
                    }
                ]
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "--debug",
                        "content": "Show debug messages\n",
                        "long": "--debug"
                    },
                    {
                        "name": "--debug-json",
                        "content": "Show debug messages including JSON metadata\n",
                        "long": "--debug-json"
                    },
                    {
                        "name": "-v --verbose",
                        "content": "Shows more detailed error messages\n\n-?, --help\nShow help\n",
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "-V --version",
                        "content": "Print program version\n",
                        "flag": "-V",
                        "long": "--version"
                    }
                ]
            },
            "NOTES": {
                "content": "The  information  provided when adding the token (SSH server address, user and paths) will be\nstored in the LUKS2 header in plaintext.\n\n",
                "subsections": []
            },
            "REPORTING BUGS": {
                "content": "Report bugs, including ones in the documentation, on the  cryptsetup  mailing  list  at  <dm-\ncrypt@saout.de>  or in the 'Issues' section on LUKS website.  Please attach the output of the\nfailed command with the --debug option added.\n\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright © 2016-2021 Red Hat, Inc.\nCopyright © 2016-2021 Milan Broz\nCopyright © 2021 Vojtech Trefny\n\nThis is free software; see the source for copying conditions.  There is NO warranty; not even\nfor MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "The project website at https://gitlab.com/cryptsetup/cryptsetup\n\n\n\ncryptsetup-ssh                                June 2021                            CRYPTSETUP-SSH(8)",
                "subsections": []
            }
        }
    }
}