~ubuntu-branches/ubuntu/maverick/krb5/maverick

« back to all changes in this revision

Viewing changes to src/windows/installer/wix/msi-deployment-guide.txt

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-10-30 10:28:53 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20061030102853-x7v876vw4af46v0m
Tags: 1.4.4-3ubuntu1
* Merge with Debian; only Ubuntu change:
  - src/include/k5-thread.h: Define__USE_GNU when #include'ing pthread.h to
    fix FTBFS (from 1.4.3-9ubuntu1).

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
     2.1.5     Kerberos V Properties
20
20
     2.2     Existing Registry Entries
21
21
     2.3     Replacing Configuration Files
22
 
     3.    Additional Resources
23
 
     4.    Upgrades
24
 
     5.    FAQ
 
22
     3.    Network Identity Manager Settings
 
23
     3.1     Common Settings for NetIDMgr
 
24
     3.1.1     General Settings
 
25
     3.1.2     Common Plug-in Settings
 
26
     3.1.3     Settings for the Kerberos 5 Credentials Provider Plug-in
 
27
     3.1.4     Settings for the kerberos 4 Credentials Provider Plug-in
 
28
     4.    Additional Resources
 
29
     5.    Upgrades
 
30
     6.    FAQ
25
31
 
26
32
----------------------------------------------------------------------
27
33
 
445
451
 
446
452
----------------------------------------------------------------------
447
453
 
448
 
3   Additional Resources
 
454
3.   Network Identity Manager Settings
 
455
 
 
456
    Configuration options for Network Identity Manager (NetIDMgr) are
 
457
    stored in the Windows registry.  Each option can exist in the user
 
458
    registry hive or the machine registry hive or both.  The value
 
459
    defined in the user hive always overrides the value defined in the
 
460
    machine registry hive.
 
461
 
 
462
    All registry keys used by NetIDMgr exist under the key
 
463
    'Software\MIT\NetIDMgr' under the user and machine hive.
 
464
    Deploying a specific configuration option can be achieved by
 
465
    setting the corresponding registry value either by authoring the
 
466
    keys into the MSI via a transform or by deploying a registry based
 
467
    Group Policy Object.  For deployment purposes, it is advisable to
 
468
    deploy values to the machine hive instead of the user hive.
 
469
    Deploying per user settings via the MSI is not supported at this
 
470
    time.
 
471
 
 
472
3.1    Common settings for NetIDMgr
 
473
 
 
474
    The following sections describe a partial list of options that can
 
475
    be specified for NetIDMgr.  Each set of options is described as a
 
476
    set of registry values.  Each section is preceded by the registry
 
477
    key under which the values of that section must be specified.
 
478
 
 
479
3.1.1    General settings
 
480
 
 
481
    Registry key : 'Software\MIT\NetIDMgr\CredWindow'
 
482
    --------------
 
483
 
 
484
    Value   : AutoInit
 
485
    Type    : DWORD  (0 or 1)
 
486
    Default : 0
 
487
 
 
488
        If this value is '1', shows the new credentials dialog if
 
489
        there are no credentials when NetIDMgr starts.
 
490
 
 
491
    Value   : AutoImport
 
492
    Type    : DWORD  (0 or 1)
 
493
    Default : 1
 
494
 
 
495
        If '1', imports credentials from the Windows LSA cache when
 
496
        NetIDMgr starts.
 
497
 
 
498
    Value   : AutoDetectNet
 
499
    Type    : DWORD  (0 or 1)
 
500
    Default : 1
 
501
 
 
502
        If '1', automatically detects network connectivity changes.
 
503
        Network connectivity change notifications are then sent out to
 
504
        individual plug-ins which can perform actions such as renewing
 
505
        credentials or obtaining new credentials.
 
506
 
 
507
    Value   : DestroyCredsOnExit
 
508
    Type    : DWORD  (0 or 1)
 
509
    Default : 0
 
510
 
 
511
        If '1', all credentials will be destroyed when NetIDMgr exits.
 
512
 
 
513
    Value   : KeepRunning
 
514
    Type    : DWORD  (0 or 1)
 
515
    Default : 1
 
516
 
 
517
        If '1', when NetIDMgr application is closed, it will continue
 
518
        to run in the Windows System Notification Area (System Tray).
 
519
        The application can be exited by choosing the 'Exit' menu
 
520
        option.  If '0', closing the application will cause it to
 
521
        exit completely.
 
522
 
 
523
3.1.2    Common Plug-in settings
 
524
 
 
525
    Registry key : 'Software\MIT\NetIDMgr\PluginManager\Plugins\<plug-in name>'
 
526
    --------------
 
527
 
 
528
    The '<plug-in name>' is one of the following for the standard plug-ins :
 
529
 
 
530
    Krb5Cred : Kerberos 5 credentials provider
 
531
    Krb5Ident: Kerberos 5 Identity provider
 
532
    Krb4Cred : Kerberos 4 credentials provider
 
533
 
 
534
    Consult the vendors for the plug-in names of other third party
 
535
    plug-ins.  Additionally, the plug-ins configuration panel in the
 
536
    NetIDMgr application provides a list of currently registered
 
537
    plug-ins.
 
538
 
 
539
    Value   : Disabled
 
540
    Type    : DWORD (0 or 1)
 
541
    Default : 0
 
542
 
 
543
        If '1', the plug-in will not be loaded.
 
544
 
 
545
    Value   : NoUnload
 
546
    Type    : DWORD (0 or 1)
 
547
    Default : 0
 
548
 
 
549
        If '1', the plug-in will not be unloaded from memory when the
 
550
        NetIDMgr application exits or if the plug-in is stopped.  The
 
551
        plug-in binary will remain loaded until NetIDMgr terminates.
 
552
 
 
553
3.1.3    Settings for the Kerberos 5 credentials provider plug-in
 
554
 
 
555
    Registry key : 'Software\MIT\NetIDMgr\PluginManager\Plugins\Krb5Cred\Parameters'
 
556
    --------------
 
557
 
 
558
    Value   : CreateMissingConfig
 
559
    Type    : DWORD (0 or 1)
 
560
    Default : 0
 
561
 
 
562
        If '1', creates any missing configuration files.
 
563
 
 
564
    Value   : MsLsaImport
 
565
    Type    : DWORD (0, 1 or 2)
 
566
    Default : 1
 
567
 
 
568
        Controls how credentials are imported from the MSLSA cache.
 
569
        This setting can be one of the following.
 
570
 
 
571
        0 : Never
 
572
        1 : Always
 
573
        2 : Only if the principal matches
 
574
 
 
575
        Note that this setting only controls how the Kerberos 5
 
576
        plug-in handles importing of credentials from the MSLSA cache.
 
577
        Whether or not credentials are imported at start-up is
 
578
        controlled via general NetIDMgr settings as described in
 
579
        section 3.1.1.
 
580
 
 
581
    Value   : MsLsaList
 
582
    Type    : DWORD (0 or 1)
 
583
    Default : 1
 
584
 
 
585
        If '1', includes credentials from the MSLSA cache in the
 
586
        credentials listing.
 
587
 
 
588
    Value   : AutoRenewTickets
 
589
    Type    : DWORD (0 or 1)
 
590
    Default : 1
 
591
 
 
592
        If '1', automatically renews expiring tickets.  The thresholds
 
593
        at which renewals happen are controlled in general NetIDMgr
 
594
        settings.
 
595
 
 
596
    Value   : UseFullRealmList
 
597
    Type    : DWORD (0 or 1)
 
598
    Default : 0
 
599
 
 
600
        If '1', uses the full realms list as determined by parsing the
 
601
        krb5.ini configuration file in the new credentials dialog box.
 
602
        If this is '0', only the last recently used list of realms
 
603
        will be used.
 
604
 
 
605
3.1.3.1    Per-identity settings
 
606
 
 
607
    Registry key 1: 'Software\MIT\NetIDMgr\KCDB\Identity\<principal name>\Krb5Cred'
 
608
    Registry key 2: 'Software\MIT\NetIDMgr\PluginManager\Plugins\Krb5Cred\Parameters\Realms\<realm>'
 
609
    Registry key 3: 'Software\MIT\NetIDMgr\PluginManager\Plugins\Krb5Cred\Parameters'
 
610
    --------------
 
611
 
 
612
    These settings are generally maintained per-identity.  However, if
 
613
    a particular setting is not specified for an identity or if the
 
614
    identity is new, then the values will be looked up in the
 
615
    per-realm configuration key and in the global parameters key in
 
616
    turn.  Global defaults should be set in the global parameters key
 
617
    (key 3).
 
618
 
 
619
    Value   : DefaultLifetime
 
620
    Type    : DWORD
 
621
    Default : 36000
 
622
 
 
623
        Default ticket lifetime, in seconds.
 
624
 
 
625
    Value   : MaxLifetime
 
626
    Type    : DWORD
 
627
    Default : 86400
 
628
 
 
629
        Maximum lifetime, in seconds.  This value is used to set the
 
630
        range of the user interface controls that allow setting the
 
631
        lifetime of a ticket.
 
632
 
 
633
    Value   : MinLifetime
 
634
    Type    : DWORD
 
635
    Default : 60
 
636
 
 
637
        Minimum lifetime, in seconds.  This value is used to set the
 
638
        range of the user interface controls that allow setting the
 
639
        lifetime of a ticket.
 
640
 
 
641
    Value   : Forwardable
 
642
    Type    : DWORD (0 or 1)
 
643
    Default : 0
 
644
 
 
645
        Obtain forwardable tickets.
 
646
 
 
647
    Value   : Proxiable
 
648
    Type    : DWORD (0 or 1)
 
649
    Default : 0
 
650
 
 
651
        Obtain proxiable tickets.
 
652
 
 
653
    Value   : Addressless
 
654
    Type    : DWORD (0 or 1)
 
655
    Default : 1
 
656
 
 
657
        Obtain addressless tickets.
 
658
 
 
659
    Value   : Renewable
 
660
    Type    : DWORD (0 or 1)
 
661
    Default : 1
 
662
 
 
663
        Obtain renewable tickets.
 
664
 
 
665
    Value   : DefaultRenewLifetime
 
666
    Type    : DWORD
 
667
    Default : 604800
 
668
 
 
669
        Default renewable lifetime, in seconds.
 
670
 
 
671
    Value   : MaxRenewLifetime
 
672
    Type    : DWORD
 
673
    Default : 2592000
 
674
 
 
675
        Maximum renewable lifetime, in seconds.  The value is used to
 
676
        set the range of the user interface controls that allow
 
677
        setting the renewable lifetime of a ticket.
 
678
 
 
679
    Value   : MinRenewLifetime
 
680
    Type    : DWORD
 
681
    Default : 60
 
682
 
 
683
        Minimum renewable lifetime, in seconds.  This value is used to
 
684
        set the range of the user interface controls that allow
 
685
        setting the renewable lifetime of a ticket.
 
686
 
 
687
3.1.4   Settings for the Kerberos 4 Credentials Provider Plug-in
 
688
 
 
689
    Registry key 1: 'Software\MIT\NetIDMgr\KCDB\Identity\<principal name>\Krb4Cred'
 
690
    Registry key 2: 'Software\MIT\NetIDMgr\PluginManager\Plugins\Krb4Cred\Parameters'
 
691
    ---------------
 
692
 
 
693
    Theses settings are also maintained per identity.  However, if the
 
694
    setting is not specified for some identity or if the identity is
 
695
    new, then the global default will be used (registry key 2).
 
696
    Global defaults should be set in the second registry key.
 
697
 
 
698
    Value   : Krb4NewCreds
 
699
    Type    : DWORD (0 or 1)
 
700
    Default : 1
 
701
 
 
702
        If '1', obtains Kerberos 4 credentials.  Note that currently,
 
703
        only one identity can have Kerberos 4 credentials at one time.
 
704
 
 
705
    Value   : Krb4Method
 
706
    Type    : DWORD (0, 1 or 2)
 
707
    Default : 0
 
708
 
 
709
        Method for obtaining Kerberos 4 credentials.  The values are
 
710
        as follows:
 
711
 
 
712
        0 : Automatically determine method
 
713
        1 : Use password
 
714
        2 : Use Kerberos 5 to 4 translation
 
715
 
 
716
    Value   : DefaultLifetime
 
717
    Type    : DWORD
 
718
    Default : 36000
 
719
 
 
720
        The default ticket lifetime, in seconds.
 
721
 
 
722
    Value   : MaxLifetime
 
723
    Type    : DWORD
 
724
    Default : 86400
 
725
 
 
726
        Maximum lifetime, in seconds.  This value is used to set the
 
727
        range of the user interface controls that allow setting the
 
728
        lifetime.
 
729
 
 
730
    Value   : MinLifetime
 
731
    Type    : DWORD
 
732
    Default : 60
 
733
 
 
734
        Minimum lifetime, in seconds.  This value is used to set the
 
735
        range of the user interface controls that allow setting the
 
736
        lifetime.
 
737
 
 
738
----------------------------------------------------------------------
 
739
 
 
740
4.   Additional Resources
449
741
 
450
742
    If you want to add registry keys or files you need to create new
451
743
    components and features for those.
476
768
 
477
769
----------------------------------------------------------------------
478
770
 
479
 
4.  Upgrades
 
771
5.  Upgrades
480
772
 
481
773
    The MSI package is designed to uninstall previous versions of
482
774
    "Kerberos for Windows" during installation.  Note that it doesn't
515
807
 
516
808
----------------------------------------------------------------------
517
809
 
518
 
5.  FAQ
 
810
6.  FAQ
519
811
 
520
812
    (Q/A's will be added here as needed)
521
813
 
522
814
----------------------------------------------------------------------
523
 
$Id: msi-deployment-guide.txt 16761 2004-09-17 14:01:42Z jaltman $
 
815
$Id: msi-deployment-guide.txt 18370 2006-07-22 00:13:30Z tlyu $
524
816