{"kind": "auth", "major": "18", "item": {"slug": "sspi", "name": "sspi", "name_zh": "", "category": "Authentication and access control", "summary": "Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details.", "aliases": [], "content_hash": "a811f463a541033670d20ca78c38f525a78c9d829b11fdb5eac072c17ae757c8", "versions": {"10": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For a SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "label": "10.23", "major": "10", "channel": "historical", "revision": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9", "source_sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9", "catalog_fingerprint": "691be281b476dde4374d7f805b2bacc2e75bdef40f1e9d3d42e91f97fe95cfd0"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9"}, {"url": "/docs/10/auth-methods.html#SSPI-AUTH", "path": "auth-methods.html", "label": "PostgreSQL 10 English manual", "sha256": "856d36a3fdfe8c45a25832e49bd07e9b7480f2ff9a33e58ac7c392630149bc34"}, {"url": "/docs/10/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 10 English manual", "sha256": "04fed609a50e8fd3013ffebb83039c544d39b6c73a6c2b2e23cd7864a70b42da"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.3.4 for details."], "manual_html": "<div class=\"sect2\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h3 class=\"title\">20.3.4.\u00a0SSPI Authentication</h3>\n</div>\n</div>\n</div>\n\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> authentication only works when both server and client are running <span class=\"productname\">Windows</span>, or, on non-Windows platforms, when <span class=\"productname\">GSSAPI</span> is available.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/10/auth-methods.html#GSSAPI-AUTH\" title=\"20.3.3.\u00a0GSSAPI Authentication\">Section\u00a020.3.3</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/10/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/10/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For a SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/10/auth-methods.html#SSPI-AUTH", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "11": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For a SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "label": "11.22", "major": "11", "channel": "historical", "revision": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0", "source_sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0", "catalog_fingerprint": "8f21f4444b7f68923f4762af0eb7937fa2907026e91249483e79050de012c901"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0"}, {"url": "/docs/11/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 11 English manual", "sha256": "39a38473d369fc90506a7fa68b1f9e350d45db3c72633f1d7828cd56fa64f8ee"}, {"url": "/docs/11/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 11 English manual", "sha256": "5477c61a002171f5b4c462052d91231c405f39d89d825faf71e52fbae358eef7"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication</h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/11/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/11/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/11/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For a SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/11/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "12": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For a SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "label": "12.22", "major": "12", "channel": "historical", "revision": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b", "source_sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b", "catalog_fingerprint": "9f857f4ee4875f9c7de6bfc9df4b757dec8b3a0bb88eadb519c7bd267bd56149"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b"}, {"url": "/docs/12/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 12 English manual", "sha256": "b2dc76c7cf21bf06635ee39033ea8ef2346f51d2f2113b13fb32605df8128509"}, {"url": "/docs/12/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 12 English manual", "sha256": "07e8cddcb38076c86dab95b72c4380a7a325f22401b5b7f9af5dd4931876f2cb"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication</h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/12/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/12/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/12/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For a SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/12/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "13": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For a SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "label": "13.23", "major": "13", "channel": "historical", "revision": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6", "source_sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6", "catalog_fingerprint": "c7015c845255c9d721c547c8ab9ef37825d332588c9691d982e6906b7d571002"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6"}, {"url": "/docs/13/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 13 English manual", "sha256": "b40fd8c45d31d5e371680aa0e117de3ed322f0afb59efeab02ad4210eae9b306"}, {"url": "/docs/13/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 13 English manual", "sha256": "3cc6ce851945cba450e6b26ecf9cae1efd3c03fb7b55e17876f4d9ea418a7c2e"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication</h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/13/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/13/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/13/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For a SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/13/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "14": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 21.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 21.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "label": "14.24", "major": "14", "channel": "stable", "revision": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897", "source_sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897", "catalog_fingerprint": "b272e6a82e4c46efda81c3a6a4cdf7de6a83dfff7f02f226a392fbe9acdd3adb"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897"}, {"url": "/docs/14/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 14 English manual", "sha256": "ae425bfdc3aea83cb0d050f040d0b3c7ece4116825b7872d1edd6020294eb7d3"}, {"url": "/docs/14/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 14 English manual", "sha256": "c9a75f04fd4a1069ea261ba061578a75c47a4b7e0bbf88761502fd4c19ccbc3f"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 21.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">21.7.\u00a0SSPI Authentication</h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/14/gssapi-auth.html\" title=\"21.6.\u00a0GSSAPI Authentication\">Section\u00a021.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/14/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/14/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/14/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "15": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 21.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 21.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "label": "15.19", "major": "15", "channel": "stable", "revision": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89", "source_sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89", "catalog_fingerprint": "fefe3c425147a86defada190c9b0663cfe02caa1724f5dede93e46457572252d"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89"}, {"url": "/docs/15/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 15 English manual", "sha256": "17ab832ee3c62e43b823e42bef216c2a4b82b8df59a4bfbace33a543f7739b34"}, {"url": "/docs/15/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 15 English manual", "sha256": "0470cd3eeb82cbc32d4b8b79e29f4427bdfd01f5bb15e6d9b7cee2f6dd2bba44"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 21.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">21.7.\u00a0SSPI Authentication</h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/15/gssapi-auth.html\" title=\"21.6.\u00a0GSSAPI Authentication\">Section\u00a021.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/15/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/15/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/15/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "16": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 21.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 21.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "label": "16.15", "major": "16", "channel": "stable", "revision": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed", "source_sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed", "catalog_fingerprint": "fa133458dc8f52e15083b4f59b7a582e2e378b608d3ac5c53054df458a374e23"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed"}, {"url": "/docs/16/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 16 English manual", "sha256": "51a343fa9add2da84f8926f4d16144e61552208b4c2a72c85eb2fa3524a36168"}, {"url": "/docs/16/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 16 English manual", "sha256": "ccc5146375a184646d5992edbc693e12c0de4431a35141d6b56c8dd6b3c52132"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 21.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">21.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/16/gssapi-auth.html\" title=\"21.6.\u00a0GSSAPI Authentication\">Section\u00a021.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/16/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/16/auth-username-maps.html\" title=\"21.2.\u00a0User Name Maps\">Section\u00a021.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/16/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "17": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "label": "17.11", "major": "17", "channel": "stable", "revision": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979", "source_sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979", "catalog_fingerprint": "4bbe3ac77becd618478f66aec420a533e9017be356c5c1d51a4b17f0fd497c07"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979"}, {"url": "/docs/17/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 17 English manual", "sha256": "7105ac7595ea70518468e9a4e266927fbb2b8acde59fbb9673a1f5a41ee2510c"}, {"url": "/docs/17/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 17 English manual", "sha256": "00c7a7c25d46aa1b2f24cd744cd4990ca4218cfafed2a4cab8c1dc1092090bba"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/17/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/17/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/17/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/17/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "18": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "revision": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f", "catalog_fingerprint": "65c93d6048ef30e61023a84f9680fa6a92b1c383b7eb226741170077eb078502"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, {"url": "/docs/18/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 18 English manual", "sha256": "9ea88dc9d2eef123fe15041dd161acafa11c32ff992d125337c640727997cb55"}, {"url": "/docs/18/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 18 English manual", "sha256": "6340d4abea2e0a3482afc31bcd1599a0fa10dc28a6f1e05d79ba831e2dd0b4c9"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/18/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/18/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/18/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/18/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "19": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "label": "19beta4", "major": "19", "channel": "preview", "revision": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86", "source_sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86", "catalog_fingerprint": "62fbf1a3689dbe8bf7e6b3372cfe6fbf867581427b3858a94c8419b77a4d2d1d"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86"}, {"url": "/docs/19/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 19 English manual", "sha256": "60bd402e05dd99868ce1dcdd037eaff7115a41e887445398041fe387cf1d87a7"}, {"url": "/docs/19/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 19 English manual", "sha256": "d05e9155d5388148c2c680ff208b62c6b3b0b1c30f302ada5ab4befec36c19b7"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/19/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/19/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/19/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/19/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "20": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "label": "20devel", "major": "20", "channel": "devel", "revision": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41", "source_sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41", "catalog_fingerprint": "398fbb9f262264053c02fbf79f88be0a6770c1473faa6ecd5931d6ec41b8258b", "source_snapshot_utc": "26-Sep-2026 20:22"}, "sources": [{"url": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41"}, {"url": "/docs/devel/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 20 English manual", "sha256": "26232e57d5f9c6a90eb77bd1f834d2663999259f2a418f570b6dae357139ff32"}, {"url": "/docs/devel/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 20 English manual", "sha256": "cf2069461da3eec62f6fb4e3df8e46fd69ff4b3a2ad059eec355cee256d7996e"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/devel/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/devel/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/devel/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/devel/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}}}, "snapshot": {"facts": [{"label": "Method", "value": "sspi"}, {"label": "Configuration", "value": "pg_hba.conf"}, {"label": "Inventory", "value": "User-visible source authentication method"}], "tables": [{"key": "method-options", "rows": [{"name": "include_realm", "description": "If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping ( Section 20.2 ). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless krb_realm is also used. It is recommended to leave include_realm set to the default (1) and to provide an explicit mapping in pg_ident.conf to convert principal names to PostgreSQL user names."}, {"name": "compat_realm", "description": "If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the include_realm option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used. Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail."}, {"name": "upn_username", "description": "If this option is enabled along with compat_realm , the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts. Note that libpq uses the SAM-compatible name if no explicit user name is specified. If you use libpq or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string."}, {"name": "map", "description": "Allows for mapping between system and database user names. See Section 20.2 for details. For an SSPI/Kerberos principal, such as username@EXAMPLE.COM (or, less commonly, username/hostbased@EXAMPLE.COM ), the user name used for mapping is username@EXAMPLE.COM (or username/hostbased@EXAMPLE.COM , respectively), unless include_realm has been set to 0, in which case username (or username/hostbased ) is what is seen as the system user name when mapping."}, {"name": "krb_realm", "description": "Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done."}], "title": "Documented method options and alternatives", "columns": [{"key": "name", "label": "Option or term"}, {"key": "description", "label": "Meaning"}]}], "aliases": [], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "revision": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f", "catalog_fingerprint": "65c93d6048ef30e61023a84f9680fa6a92b1c383b7eb226741170077eb078502"}, "sources": [{"url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "Matching PostgreSQL source archive", "sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, {"url": "/docs/18/sspi-auth.html", "path": "sspi-auth.html", "label": "PostgreSQL 18 English manual", "sha256": "9ea88dc9d2eef123fe15041dd161acafa11c32ff992d125337c640727997cb55"}, {"url": "/docs/18/auth-pg-hba-conf.html", "path": "auth-pg-hba-conf.html", "label": "PostgreSQL 18 English manual", "sha256": "6340d4abea2e0a3482afc31bcd1599a0fa10dc28a6f1e05d79ba831e2dd0b4c9"}], "sections": [], "signature": "", "attributes": {"method": "sspi", "inventory": "User-visible source authentication method", "configuration": "pg_hba.conf"}, "description": ["Use SSPI to authenticate the user. This is only available on Windows. See Section 20.7 for details."], "manual_html": "<div class=\"sect1\" id=\"SSPI-AUTH\">\n<div class=\"titlepage\">\n<div>\n<div>\n<h2 class=\"title\">20.7.\u00a0SSPI Authentication </h2>\n</div>\n</div>\n</div>\n<p><span class=\"productname\">SSPI</span> is a <span class=\"productname\">Windows</span> technology for secure authentication with single sign-on. <span class=\"productname\">PostgreSQL</span> will use SSPI in <code class=\"literal\">negotiate</code> mode, which will use <span class=\"productname\">Kerberos</span> when possible and automatically fall back to <span class=\"productname\">NTLM</span> in other cases. <span class=\"productname\">SSPI</span> and <span class=\"productname\">GSSAPI</span> interoperate as clients and servers, e.g., an <span class=\"productname\">SSPI</span> client can authenticate to an <span class=\"productname\">GSSAPI</span> server. It is recommended to use <span class=\"productname\">SSPI</span> on Windows clients and servers and <span class=\"productname\">GSSAPI</span> on non-Windows platforms.</p>\n<p>When using <span class=\"productname\">Kerberos</span> authentication, <span class=\"productname\">SSPI</span> works the same way <span class=\"productname\">GSSAPI</span> does; see <a class=\"xref\" href=\"/docs/18/gssapi-auth.html\" title=\"20.6.\u00a0GSSAPI Authentication\">Section\u00a020.6</a> for details.</p>\n<p>The following configuration options are supported for <span class=\"productname\">SSPI</span>:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"literal\">include_realm</code></span></dt>\n<dd>\n<p>If set to 0, the realm name from the authenticated user principal is stripped off before being passed through the user name mapping (<a class=\"xref\" href=\"/docs/18/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a>). This is discouraged and is primarily available for backwards compatibility, as it is not secure in multi-realm environments unless <code class=\"literal\">krb_realm</code> is also used. It is recommended to leave <code class=\"literal\">include_realm</code> set to the default (1) and to provide an explicit mapping in <code class=\"filename\">pg_ident.conf</code> to convert principal names to <span class=\"productname\">PostgreSQL</span> user names.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">compat_realm</code></span></dt>\n<dd>\n<p>If set to 1, the domain's SAM-compatible name (also known as the NetBIOS name) is used for the <code class=\"literal\">include_realm</code> option. This is the default. If set to 0, the true realm name from the Kerberos user principal name is used.</p>\n<p>Do not disable this option unless your server runs under a domain account (this includes virtual service accounts on a domain member system) and all clients authenticating through SSPI are also using domain accounts, or authentication will fail.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">upn_username</code></span></dt>\n<dd>\n<p>If this option is enabled along with <code class=\"literal\">compat_realm</code>, the user name from the Kerberos UPN is used for authentication. If it is disabled (the default), the SAM-compatible user name is used. By default, these two names are identical for new user accounts.</p>\n<p>Note that <span class=\"application\">libpq</span> uses the SAM-compatible name if no explicit user name is specified. If you use <span class=\"application\">libpq</span> or a driver based on it, you should leave this option disabled or explicitly specify user name in the connection string.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">map</code></span></dt>\n<dd>\n<p>Allows for mapping between system and database user names. See <a class=\"xref\" href=\"/docs/18/auth-username-maps.html\" title=\"20.2.\u00a0User Name Maps\">Section\u00a020.2</a> for details. For an SSPI/Kerberos principal, such as <code class=\"literal\">username@EXAMPLE.COM</code> (or, less commonly, <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>), the user name used for mapping is <code class=\"literal\">username@EXAMPLE.COM</code> (or <code class=\"literal\">username/hostbased@EXAMPLE.COM</code>, respectively), unless <code class=\"literal\">include_realm</code> has been set to 0, in which case <code class=\"literal\">username</code> (or <code class=\"literal\">username/hostbased</code>) is what is seen as the system user name when mapping.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"literal\">krb_realm</code></span></dt>\n<dd>\n<p>Sets the realm to match user principal names against. If this parameter is set, only users of that realm will be accepted. If it is not set, users of any realm can connect, subject to whatever user name mapping is done.</p>\n</dd>\n</dl>\n</div>\n</div>", "manual_path": "/docs/18/sspi-auth.html", "comparison_data": {"method": "sspi", "documented_option_names": ["compat_realm", "include_realm", "krb_realm", "map", "upn_username"]}, "comparison_hash": "0220f8a01c511536c8f908389cce9eb03bab3d3ab8ba3aa2bd8f685651f29377"}, "comparison": {"left": "17", "right": "18", "status": "unchanged", "diff": ""}}