ruby.git - Ruby GIT repository

diff options
author	usa <usa@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>	2007-05-08 11:41:13 +0000
committer	usa <usa@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>	2007-05-08 11:41:13 +0000
commit	937b06be80774e616507d0e4341b832c3a2581b6 (patch)
tree	21bc0d3f0340e734d680d9d797bcf2787da2d16a /lib/webrick/httpauth
parent	f52ec0d2f3bba31c462d387b00a756a9191e83d9 (diff)
* 2007-05-08
git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@12255 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/webrick/httpauth')
0 files changed, 0 insertions, 0 deletions
a> 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

    <refmeta>
        <refentrytitle>sssd-ipa</refentrytitle>
        <manvolnum>5</manvolnum>
        <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
    </refmeta>

    <refnamediv id='name'>
        <refname>sssd-ipa</refname>
        <refpurpose>SSSD IPA provider</refpurpose>
    </refnamediv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            This manual page describes the configuration of the IPA provider
            for
            <citerefentry>
                <refentrytitle>sssd</refentrytitle>
                <manvolnum>8</manvolnum>
            </citerefentry>.
            For a detailed syntax reference, refer to the <quote>FILE FORMAT</quote> section of the
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> manual page.
        </para>
        <para>
            The IPA provider is a back end used to connect to an IPA server.
            (Refer to the freeipa.org web site for information about IPA servers.)
            This provider requires that the machine be joined to the IPA domain;
            configuration is almost entirely self-discovered and obtained
            directly from the server.
        </para>
        <para>
            The IPA provider accepts the same options used by the
            <citerefentry>
                <refentrytitle>sssd-ldap</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> identity provider and the
            <citerefentry>
                <refentrytitle>sssd-krb5</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> authentication provider with some exceptions described
            below.
        </para>
        <para>
            However, it is neither necessary nor recommended to set these options.
            IPA provider can also be used as an access and chpass provider. As an
            access provider it uses HBAC (host-based access control) rules. Please
            refer to freeipa.org for more information about HBAC. No configuration
            of access provider is required on the client side.
        </para>
        <para>
            The IPA provider will use the PAC responder if the Kerberos tickets
            of users from trusted realms contain a PAC. To make configuration
            easier the PAC responder is started automatically if the IPA ID
            provider is configured.
        </para>
    </refsect1>

    <refsect1 id='configuration-options'>
        <title>CONFIGURATION OPTIONS</title>
        <para>Refer to the section <quote>DOMAIN SECTIONS</quote> of the
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> manual page for details on the configuration of an SSSD domain.
            <variablelist>
                <varlistentry>
                    <term>ipa_domain (string)</term>
                    <listitem>
                        <para>
                            Specifies the name of the IPA domain.
                            This is optional. If not provided, the configuration
                            domain name is used.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_server, ipa_backup_server (string)</term>
                    <listitem>
                        <para>
                            The comma-separated list of IP addresses or hostnames of the
                            IPA servers to which SSSD should connect in
                            the order of preference. For more information
                            on failover and server redundancy, see the
                            <quote>FAILOVER</quote> section.
                            This is optional if autodiscovery is enabled.
                            For more information on service discovery, refer
                            to the <quote>SERVICE DISCOVERY</quote> section.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_hostname (string)</term>
                    <listitem>
                        <para>
                            Optional. May be set on machines where the
                            hostname(5) does not reflect the fully qualified
                            name used in the IPA domain to identify this host.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_update (boolean)</term>
                    <listitem>
                        <para>
                            Optional. This option tells SSSD to automatically
                            update the DNS server built into FreeIPA v2 with
                            the IP address of this client. The update is
                            secured using GSS-TSIG. The IP address of the IPA
                            LDAP connection is used for the updates, if it is
                            not otherwise specified by using the
                            <quote>dyndns_iface</quote> option.
                        </para>
                        <para>
                            NOTE: On older systems (such as RHEL 5), for this
                            behavior to work reliably, the default Kerberos
                            realm must be set properly in /etc/krb5.conf
                        </para>
                        <para>
                            NOTE: While it is still possible to use the old
                            <emphasis>ipa_dyndns_update</emphasis> option, users
                            should migrate to using <emphasis>dyndns_update</emphasis>
                            in their config file.
                        </para>
                        <para>
                            Default: false
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_ttl (integer)</term>
                    <listitem>
                        <para>
                            The TTL to apply to the client DNS record when updating it.
                            If dyndns_update is false this has no effect. This will
                            override the TTL serverside if set by an administrator.
                        </para>
                        <para>
                            NOTE: While it is still possible to use the old
                            <emphasis>ipa_dyndns_ttl</emphasis> option, users
                            should migrate to using <emphasis>dyndns_ttl</emphasis>
                            in their config file.
                        </para>
                        <para>
                            Default: 1200 (seconds)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_iface (string)</term>
                    <listitem>
                        <para>
                            Optional. Applicable only when dyndns_update
                            is true. Choose the interface whose IP address
                            should be used for dynamic DNS updates.
                        </para>
                        <para>
                            NOTE: While it is still possible to use the old
                            <emphasis>ipa_dyndns_iface</emphasis> option, users
                            should migrate to using <emphasis>dyndns_iface</emphasis>
                            in their config file.
                        </para>
                        <para>
                            Default: Use the IP address of the IPA LDAP connection
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_enable_dns_sites (boolean)</term>
                    <listitem>
                        <para>
                            Enables DNS sites - location based
                            service discovery.
                        </para>
                        <para>
                            If true and service discovery (see Service
                            Discovery paragraph at the bottom of the man page)
                            is enabled, then the SSSD will first attempt
                            location based discovery using a query that contains
                            "_location.hostname.example.com" and then fall back
                            to traditional SRV discovery. If the location based
                            discovery succeeds, the IPA servers located with
                            the location based discovery are treated as primary
                            servers and the IPA servers located using the
                            traditional SRV discovery are used as back up
                            servers
                        </para>
                        <para>
                            Default: false
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_refresh_interval (integer)</term>
                    <listitem>
                        <para>
                            How often should the back end perform periodic DNS update in
                            addition to the automatic update performed when the back end
                            goes online.
                            This option is optional and applicable only when dyndns_update
                            is true.
                        </para>
                        <para>
                            Default: 0 (disabled)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_update_ptr (bool)</term>
                    <listitem>
                        <para>
                            Whether the PTR record should also be explicitly
                            updated when updating the client's DNS records.
                            Applicable only when dyndns_update is true.
                        </para>
                        <para>
                            This option should be False in most IPA
                            deployments as the IPA server generates the
                            PTR records automatically when forward records
                            are changed.
                        </para>
                        <para>
                            Default: False (disabled)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>dyndns_force_tcp (bool)</term>
                    <listitem>
                        <para>
                            Whether the nsupdate utility should default to using
                            TCP for communicating with the DNS server.
                        </para>
                        <para>
                            Default: False (let nsupdate choose the protocol)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_hbac_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            HBAC related objects.
                        </para>
                        <para>
                            Default: Use base DN
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_host_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            host objects.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>ldap_search_base</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_selinux_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            SELinux user maps.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>ldap_search_base</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_subdomains_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            trusted domains.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>cn=trusts,%basedn</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_master_domain_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            master domain object.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>cn=ad,cn=etc,%basedn</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_views_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            views containers.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>cn=views,cn=accounts,%basedn</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>krb5_validate (boolean)</term>
                    <listitem>
                        <para>
                            Verify with the help of krb5_keytab that the TGT
                            obtained has not been spoofed.
                        </para>
                        <para>
                            Default: true
                        </para>
                        <para>
                             Note that this default differs from the
                             traditional Kerberos provider back end.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>krb5_realm (string)</term>
                    <listitem>
                        <para>
                            The name of the Kerberos realm. This is optional and
                            defaults to the value of <quote>ipa_domain</quote>.
                        </para>
                        <para>
                            The name of the Kerberos realm has a special
                            meaning in IPA - it is converted into the base
                            DN to use for performing LDAP operations.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>krb5_canonicalize (boolean)</term>
                    <listitem>
                        <para>
                            Specifies if the host and user principal should be
                            canonicalized when connecting to IPA LDAP and also for AS
                            requests. This feature is available with MIT
                            Kerberos >= 1.7
                        </para>

                        <para>
                            Default: true
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>krb5_use_fast (string)</term>
                    <listitem>
                        <para>
                            Enables flexible authentication secure tunneling
                            (FAST) for Kerberos pre-authentication. The
                            following options are supported:
                        </para>
                        <para>
                            <emphasis>never</emphasis> use FAST.
                        </para>
                        <para>
                            <emphasis>try</emphasis> to use FAST. If the server
                            does not support FAST, continue the
                            authentication without it. This is
                            equivalent to not setting this option at all.
                        </para>
                        <para>
                            <emphasis>demand</emphasis> to use FAST. The
                            authentication fails if the server does not
                            require fast.
                        </para>
                        <para>
                            Default: try
                        </para>
                        <para>
                            NOTE: SSSD supports FAST only with
                            MIT Kerberos version 1.8 and later. If SSSD is used
                            with an older version of MIT Kerberos, using this
                            option is a configuration error.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_hbac_refresh (integer)</term>
                    <listitem>
                        <para>
                            The amount of time between lookups of the HBAC
                            rules against the IPA server. This will reduce the
                            latency and load on the IPA server if there are
                            many access-control requests made in a short
                            period.
                        </para>
                        <para>
                            Default: 5 (seconds)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_hbac_selinux (integer)</term>
                    <listitem>
                        <para>
                            The amount of time between lookups of the SELinux
                            maps against the IPA server. This will reduce the
                            latency and load on the IPA server if there are
                            many user login requests made in a short
                            period.
                        </para>
                        <para>
                            Default: 5 (seconds)
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_hbac_treat_deny_as (string)</term>
                    <listitem>
                        <para>
                            This option specifies how to treat the deprecated
                            DENY-type HBAC rules. As of FreeIPA v2.1, DENY
                            rules are no longer supported on the server. All
                            users of FreeIPA will need to migrate their rules
                            to use only the ALLOW rules. The client will
                            support two modes of operation during this
                            transition period:
                        </para>
                        <para>
                            <emphasis>DENY_ALL</emphasis>: If any HBAC DENY
                            rules are detected, all users will be denied
                            access.
                        </para>
                        <para>
                            <emphasis>IGNORE</emphasis>: SSSD will ignore any
                            DENY rules. Be very careful with this option, as
                            it may result in opening unintended access.
                        </para>
                        <para>
                            Default: DENY_ALL
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_server_mode (boolean)</term>
                    <listitem>
                        <para>
                            This option should only be set by the IPA
                            installer.
                        </para>
                        <para>
                            The option denotes that the SSSD is running on
                            IPA server and should perform lookups of users
                            and groups from trusted domains differently.
                        </para>
                        <para>
                            Default: false
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry condition="with_autofs">
                    <term>ipa_automount_location (string)</term>
                    <listitem>
                        <para>
                            The automounter location this IPA client will be using
                        </para>
                        <para>
                            Default: The location named "default"
                        </para>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/autofs_restart.xml" />
                    </listitem>
                </varlistentry>
            </variablelist>
        </para>
        <refsect2 id='views'>
            <title>VIEWS AND OVERRIDES</title>
            <para>
                SSSD can handle views and overrides which are offered by
                FreeIPA 4.1 and later version. Since all paths and objectclasses
                are fixed on the server side there is basically no need to
                configure anything. For completeness the related options are
                listed here with their default values.
                <variablelist>
                    <varlistentry>
                        <term>ipa_view_class (string)</term>
                        <listitem>
                            <para>
                                Objectclass of the view container.
                            </para>
                            <para>
                                Default: nsContainer
                            </para>
                        </listitem>
                    </varlistentry>

                    <varlistentry>
                        <term>ipa_view_name (string)</term>
                        <listitem>
                            <para>
                                Name of the attribute holding the name of the
                                view.
                            </para>
                            <para>
                                Default: cn
                            </para>
                        </listitem>
                    </varlistentry>

                    <varlistentry>
                        <term>ipa_overide_object_class (string)</term>
                        <listitem>
                            <para>
                                Objectclass of the override objects.
                            </para>
                            <para>
                                Default: ipaOverrideAnchor
                            </para>
                        </listitem>
                    </varlistentry>

                    <varlistentry>
                        <term>ipa_anchor_uuid (string)</term>
                        <listitem>
                            <para>
                                Name of the attribute containing the reference
                                to the original object in a remote domain.
                            </para>
                            <para>
                                Default: ipaAnchorUUID
                            </para>
                        </listitem>
                    </varlistentry>

                    <varlistentry>
                        <term>ipa_user_override_object_class (string)</term>
                        <listitem>
                            <para>
                                Name of the objectclass for user overrides. It
                                is used to determine if the found override
                                object is related to a user or a group.
                            </para>
                            <para>
                                User overrides can contain attributes given by
                                <itemizedlist>
                                    <listitem>
                                        <para>ldap_user_name</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_user_uid_number</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_user_gid_number</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_user_gecos</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_user_home_directory</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_user_shell</para>
                                    </listitem>
                                </itemizedlist>
                            </para>
                            <para>
                                Default: ipaUserOverride
                            </para>
                        </listitem>
                    </varlistentry>

                    <varlistentry>
                        <term>ipa_group_override_object_class (string)</term>
                        <listitem>
                            <para>
                                Name of the objectclass for group overrides. It
                                is used to determine if the found override
                                object is related to a user or a group.
                            </para>
                            <para>
                                Group overrides can contain attributes given by
                                <itemizedlist>
                                    <listitem>
                                        <para>ldap_group_name</para>
                                    </listitem>
                                    <listitem>
                                        <para>ldap_group_gid_number</para>
                                    </listitem>
                                </itemizedlist>
                            </para>
                            <para>
                                Default: ipaGroupOverride
                            </para>
                        </listitem>
                    </varlistentry>
                </variablelist>
            </para>
        </refsect2>
    </refsect1>

    <refsect1 id='subdomains_provider'>
        <title>SUBDOMAINS PROVIDER</title>

context:
space:
mode: