pegasus/doc/PegasusSSLGuidelines.htm - diff

Return to PegasusSSLGuidelines.htm CVS log

Up to [Pegasus] / pegasus / doc

Diff for /pegasus/doc/PegasusSSLGuidelines.htm between version 1.4.4.2 and 1.5

version 1.4.4.2, 2006/12/19 10:49:51

version 1.5, 2008/12/16 18:55:36

Line 1

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html xmlns:v="urn:schemas-microsoft-com:vml"

<html>

xmlns:o="urn:schemas-microsoft-com:office:office"

xmlns:w="urn:schemas-microsoft-com:office:word"

xmlns:st1="urn:schemas-microsoft-com:office:smarttags"

xmlns="http://www.w3.org/TR/REC-html40" xmlns:o>

<head>

<!--[if !mso]>

<style>

v\:* {behavior:url(#default#VML);}

o\:* {behavior:url(#default#VML);}

w\:* {behavior:url(#default#VML);}

.shape {behavior:url(#default#VML);}

</style>

<![endif]-->

<title>OpenPegasus SSL Guidelines</title>

<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"

name="date"/>

<!--[if gte mso 9]><xml>

<o:DocumentProperties>

<o:Author>IBM_USER</o:Author>

<o:LastAuthor>IBM_USER</o:LastAuthor>

<o:Revision>2</o:Revision>

<o:TotalTime>6</o:TotalTime>

<o:Created>2006-12-19T07:20:00Z</o:Created>

<o:LastSaved>2006-12-19T07:26:00Z</o:LastSaved>

<o:Pages>1</o:Pages>

<o:Words>5126</o:Words>

<o:Characters>29220</o:Characters>

<o:Company>IBM</o:Company>

<o:Lines>243</o:Lines>

<o:Paragraphs>68</o:Paragraphs>

<o:CharactersWithSpaces>34278</o:CharactersWithSpaces>

<o:Version>10.3501</o:Version>

</o:DocumentProperties>

</xml><![endif]--><!--[if gte mso 9]><xml>

<w:WordDocument>

<w:SpellingState>Clean</w:SpellingState>

<w:GrammarState>Clean</w:GrammarState>

<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>

</w:WordDocument>

</xml><![endif]--><!--[if !mso]><object

classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object>

<style>

st1\:*{behavior:url(#ieooui) }

</style>

<![endif]-->

<style>

<!--

/* Font Definitions */

@font-face

{font-family:Courier;

panose-1:2 7 4 9 2 2 5 2 4 4;

mso-font-charset:0;

mso-generic-font-family:modern;

mso-font-format:other;

mso-font-pitch:fixed;

mso-font-signature:3 0 0 0 1 0;}

@font-face

{font-family:Wingdings;

panose-1:5 0 0 0 0 0 0 0 0 0;

mso-font-charset:2;

mso-generic-font-family:auto;

mso-font-pitch:variable;

mso-font-signature:0 268435456 0 0 -2147483648 0;}

@font-face

{font-family:Times;

panose-1:2 2 6 3 5 4 5 2 3 4;

mso-font-charset:0;

mso-generic-font-family:roman;

mso-font-pitch:variable;

mso-font-signature:536902279 -2147483648 8 0 511 0;}

/* Style Definitions */

p.MsoNormal, li.MsoNormal, div.MsoNormal

{mso-style-parent:"";

margin:0in;

margin-bottom:.0001pt;

mso-pagination:widow-orphan;

font-size:12.0pt;

font-family:"Times New Roman";

mso-fareast-font-family:"Times New Roman";}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:2;

font-size:18.0pt;

font-family:"Times New Roman";

font-weight:bold;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:3;

font-size:13.5pt;

font-family:"Times New Roman";

font-weight:bold;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

mso-outline-level:4;

font-size:12.0pt;

font-family:"Times New Roman";

font-weight:bold;}

a:link, span.MsoHyperlink

{color:blue;

text-decoration:underline;

text-underline:single;}

a:visited, span.MsoHyperlinkFollowed

{color:blue;

text-decoration:underline;

text-underline:single;}

{mso-margin-top-alt:auto;

margin-right:0in;

mso-margin-bottom-alt:auto;

margin-left:0in;

mso-pagination:widow-orphan;

font-size:12.0pt;

font-family:"Times New Roman";

mso-fareast-font-family:"Times New Roman";}

span.spelle

{mso-style-name:spelle;}

span.SpellE

{mso-style-name:"";

mso-spl-e:yes;}

span.GramE

{mso-style-name:"";

mso-gram-e:yes;}

@page Section1

{size:8.5in 11.0in;

margin:1.0in 1.25in 1.0in 1.25in;

mso-header-margin:.5in;

mso-footer-margin:.5in;

mso-paper-source:0;}

div.Section1

{page:Section1;}

/* List Definitions */

@list l0

{mso-list-id:51972189;

mso-list-template-ids:81668992;}

@list l0:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l1

{mso-list-id:257178838;

mso-list-template-ids:1636469146;}

@list l1:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l2

{mso-list-id:335961387;

mso-list-template-ids:303987346;}

@list l2:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l3

{mso-list-id:432287186;

mso-list-template-ids:401260786;}

@list l3:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l4

{mso-list-id:448670368;

mso-list-template-ids:342922132;}

@list l4:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l5

{mso-list-id:605886313;

mso-list-template-ids:2101529026;}

@list l5:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l6

{mso-list-id:610279438;

mso-list-template-ids:-795200846;}

@list l6:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l7

{mso-list-id:620840603;

mso-list-template-ids:-1801667564;}

@list l7:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l8

{mso-list-id:633027112;

mso-list-template-ids:-1360881254;}

@list l8:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l9

{mso-list-id:902104985;

mso-list-template-ids:750025012;}

@list l9:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l10

{mso-list-id:958562085;

mso-list-template-ids:-55920690;}

@list l10:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l11

{mso-list-id:1106390704;

mso-list-template-ids:-953544102;}

@list l11:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l11:level2

{mso-level-number-format:bullet;

mso-level-text:o;

mso-level-tab-stop:1.0in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:"Courier New";

mso-bidi-font-family:"Times New Roman";}

@list l11:level3

{mso-level-number-format:bullet;

mso-level-text:\F0A7;

mso-level-tab-stop:1.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Wingdings;}

@list l12

{mso-list-id:1409960379;

mso-list-template-ids:-1094543752;}

@list l12:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l13

{mso-list-id:1721326241;

mso-list-template-ids:644010464;}

@list l13:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l14

{mso-list-id:1731073149;

mso-list-template-ids:-2060307636;}

@list l14:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

@list l15

{mso-list-id:1950238906;

mso-list-template-ids:-1705468504;}

@list l15:level1

{mso-level-number-format:bullet;

mso-level-text:\F0B7;

mso-level-tab-stop:.5in;

mso-level-number-position:left;

text-indent:-.25in;

mso-ansi-font-size:10.0pt;

font-family:Symbol;}

{margin-bottom:0in;}

-->

</style>

<!--[if gte mso 10]>

<style>

/* Style Definitions */

table.MsoNormalTable

{mso-style-name:"Table Normal";

mso-tstyle-rowband-size:0;

mso-tstyle-colband-size:0;

mso-style-noshow:yes;

mso-style-parent:"";

mso-padding-alt:0in 5.4pt 0in 5.4pt;

mso-para-margin:0in;

mso-para-margin-bottom:.0001pt;

mso-pagination:widow-orphan;

font-size:10.0pt;

font-family:"Times New Roman";}

</style>

<![endif]-->

</head>

<body>

<h2>OpenPegasus 2.5.1 SSL Guidelines</h2>

Version: 1.1

Created: July 20, 2005

Updated: March 20, 2006

<ul>

<h2>OpenPegasus 2.6 SSL Guidelines</h2>

<li><a href="#OVERVIEW">Overview</a> </li>

<li><a href="#RELATED">Related Information</a> </li>

Version: 1.2

<li><a href="#BUILDING">Building Pegasus with SSL</a> </li>

Created: <st1:date Year="2005" Day="20" Month="7">July 20, 2005</st1:date>

<li><a href="#CERTS">Creating SSL Certificates</a> </li>

<li><a href="#CONFIGURE">Configuring Pegasus for SSL</a> </li>

Updated: <st1:date Year="2006" Day="19"

<li><a href="#DESIGN">SSL Design Question List</a> </li>

Month="12">December 19, 2006</st1:date>

<li><a href="#TRUSTSTORE">Truststore Management</a> </li>

<li><a href="#CLI">cimtrust & cimcrl CLI</a> </li>

<li><a href="#CLIENT">Configuring the Pegasus CIM Client for SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li><a href="#AUTH">SSL Authorization</a> </li>

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#OVERVIEW">Overview</a>

<li><a href="#EXT">Critical Extension Handling</a> </li>

</li>

<li><a href="#RESOURCES">Resources</a>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#RELATED">Related

Information</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#BUILDING">Building

Pegasus with SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CERTS">Creating SSL

Certificates</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CONFIGURE">Configuring

Pegasus for SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#DESIGN">SSL Design

Question List</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#TRUSTSTORE"><span

class=SpellE>Truststore Management</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CLI"><span

class=SpellE>cimtrust & cimcrl CLI</a>

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#CLIENT">Configuring

the Pegasus CIM Client for SSL</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#AUTH">SSL

Authorization</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#EXT">Critical

Extension Handling</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l7 level1 lfo1;tab-stops:list .5in'><a href="#RESOURCES">Resources</a>

</li>

</ul>

<h3><a name="OVERVIEW">Overview</a></h3>

<h3><a name=OVERVIEW>Overview</a></h3>

The following document serves as a guide on how to build and configure

The following document serves as a guide on how to build and configure

Pegasus for SSL support. It also discusses how to utilize a

Pegasus for SSL support. It also discusses how to utilize a certificate-based

certificate-based

infrastructure and configure the Pegasus CIM client.

This guide requires a basic understanding of SSL, OpenSSL, and basic

This guide requires a basic understanding of SSL, OpenSSL,

authentication. This guide is intended to help developers and

and basic authentication. This guide is intended to help developers and

administrators make the right decisions about how to use SSL for their

particular application. It is not intended to be a primary source of education

particular application. It is not intended to be a primary source of

on SSL. If you are not familiar with these technologies,

education on SSL. If you are not familiar with these technologies,

consult the sources in the <a href="#RESOURCES">Resources</a> section at the

consult the sources in the <a href="#RESOURCES">Resources</a> section

bottom.

at the bottom.

Note: In this document, the term "trust" refers only to

authentication. It does not imply full trust in the traditional sense, because

Note: In this document, the term "trust" refers only to

it does not take into account authorization checks. It remains the

authentication. It does not imply full trust in the traditional sense,

responsibility of providers and clients to perform authorization, and therefore

because it does not take into account authorization checks. It remains

establish real trust. Likewise, the term "Trust Store" can be

the responsibility of providers and clients to perform authorization,

misleading since the "store" is only a source of authentication

and therefore establish real trust. Likewise, the term "Trust Store"

credentials. Please bear this in mind when documenting recommended deployments

can be misleading since the "store" is only a source of authentication

or building clients or providers.

credentials. Please bear this in mind when documenting recommended

deployments or building clients or providers.

<h3><a name=RELATED>Related Information</a></h3>

<h3><a name="RELATED">Related Information</a></h3>

A significant portion of the information in this document is

A significant portion of the information in this document is taken from

taken from various PEP's.

various PEP's. This document attempts to bring all of this information

This document attempts to bring all of this information together in a cohesive

together in a cohesive and simplified format.

and simplified format.

<ul>

<li>PEP#035 - Add support for /dev/random in SSLContext</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li>PEP#060 - SSL support in CIM/XML indication delivery</li>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#035 - Add support for

<li>PEP#074 - SSLContext and Certificate verification interface

/dev/random in SSLContext </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#060 - SSL support in

CIM/XML indication delivery </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#074 - <span

class=SpellE>SSLContext and Certificate verification interface

enhancement </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li>PEP#165 - SSL Client Verification</li>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#165 - SSL Client

<li>PEP#187 - SSL Certificate Management Enhancements</li>

Verification </li>

<li>PEP#200 - Recommended OpenPegasus 2.5 Build and Configuration

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

Options for Selected Platforms</li>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#187 - SSL Certificate

</ul>

Management Enhancements </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<h3><a name="BUILDING">Building Pegasus with SSL</a></h3>

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#200 - Recommended <span

To build Pegasus with HTTPS support, you will need to build against

class=SpellE>OpenPegasus 2.5 Build and Configuration Options for

the <a href="http://www.openssl.org">OpenSSL package</a>. <font

Selected Platforms</li>

style="color: rgb(0, 0, 0);" color="MAGENTA">The SSL support outlined

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

here has been tested against recent releases of the major versions

mso-list:l15 level1 lfo2;tab-stops:list .5in'>PEP#268 � SSL Client Certificate

0.9.7X and 0.9.8X (most notably, 0.9.7d). Because some versions of

Propagation</li>

0.9.6X do not contain full support for the security functions that

</ul>

Pegasus utilizes (for example, certificate-based authentication is not

fully supported by some versions of 0.9.6X), Pegasus does not

<h3><a name=BUILDING>Building Pegasus with SSL</a></h3>

officially support major version 0.9.6.

See Bugzilla 4048 for more information.

To build Pegasus with HTTPS support, you will need to build against the <a

Because this is an open source project, the SSL support has been tested

href="http://www.openssl.org">OpenSSL package</a>. <span

with many versions of OpenSSL, but we cannot guarantee it has been

style='color:black'>The SSL support outlined here has been tested against

tested with every version on every platform. A list of recent OpenSSL

recent releases of the major versions 0.9.7X and 0.9.8X (most notably, 0.9.7d).

releases, and important-to-review security advisories and fixes, can

Because some versions of 0.9.6X do not contain full support for the security

be found on the <a href="http://www.openssl.org/news">OpenSSL News page</a>.

functions that Pegasus utilizes (for example, certificate-based authentication

is not fully supported by some versions of 0.9.6X), Pegasus does not officially

support major version 0.9.6. See Bugzilla 4048 for

more information. Because this is an open source project, the SSL

support has been tested with many versions of OpenSSL,

but we cannot guarantee it has been tested with every version on every

platform. A list of recent OpenSSL releases, and

important-to-review security advisories and fixes, can be found on the <a

href="http://www.openssl.org/news">OpenSSL News page</a>.

After grabbing the OpenSSL source <span

After grabbing the OpenSSL source tarball, you need to set the

class=SpellE>tarball, you need to set the following environment

following environment variables before building Pegasus:

variables before building Pegasus:

<ul>

<li>PEGASUS_HAS_SSL=1</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li>OPENSSL_HOME=<location of the SDK package> This directory

mso-list:l14 level1 lfo3;tab-stops:list .5in'>PEGASUS_HAS_SSL=1 </li>

must contain the OpenSSL include directory, $(OPENSSL_HOME)/include,

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

and the OpenSSL library directory, $(OPENSSL_HOME)/lib.</li>

mso-list:l14 level1 lfo3;tab-stops:list .5in'>OPENSSL_HOME=<location of

<li>OPENSSL_BIN=<location of the binary package> This only

the SDK package> This directory must contain

needs to be set if the OpenSSL binaries are not in $(OPENSSL_HOME)/bin.</li>

the OpenSSL include directory,

</ul>

$(OPENSSL_HOME)/include, and the OpenSSL library

Note that Pegasus supports SSLv3 and TLSv1 by default. It does NOT

directory, $(OPENSSL_HOME)/lib. </li>

support SSLv2. To turn on SSLv2 support, enable the additional

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

environment variable:

mso-list:l14 level1 lfo3;tab-stops:list .5in'>OPENSSL_BIN=<location of

<ul>

the binary package> This only needs to be set

<li> PEGASUS_ENABLE_SSLV2=1 </li>

if the OpenSSL binaries are not in

</ul>

$(OPENSSL_HOME)/bin.</li>

</ul>

It is not recommended to enable this protocol, as there have been many

security weaknesses associated with it. Unless you are dealing

Note that Pegasus supports SSLv3 and TLSv1 by default. It

with very outdated clients, you probably do not need to enable it.

does NOT support SSLv2. To turn on SSLv2 support, enable the additional

environment variable:

After setting these variables, proceed as normal with the build

instructions in the readme file.

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<h3><a name="CERTS">Creating SSL Certificates</a></h3>

mso-list:l9 level1 lfo4;tab-stops:list .5in'>PEGASUS_ENABLE_SSLV2=1 </li>

There are two options for creating the CIMOM's certificate:

</ul>

<ul>

<li>Self-signed certificate</li>

It is not recommended to enable this protocol, as there have been many

<li>Certificate issued by a third-party certificate authority</li>

security weaknesses associated with it. Unless you are dealing with very

</ul>

outdated clients, you probably do not need to enable it.

To generate a self-signed certificate, you must create a private key, a

After setting these variables, proceed as normal with the build instructions

certificate signing request (CSR), and finally the public x509

in the readme file.

certificate.

You also need an SSL configuration file that defines the parameters of

<h3><a name=CERTS>Creating SSL Certificates</a></h3>

the Distinguished Name (DN). You can use the one that comes with

Pegasus, ssl.cnf in the root directory, or generate your own. For a

There are two options for creating the CIMOM's

self-signed certificate, the subject

certificate:

is the same as the issuer. Execute the following commands to create a

self-signed certificate. The PEGASUS_ROOT and PEGASUS_HOME have to be

set to your respective installation and source directory. You will also

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

need an OpenSSL configuration

mso-list:l5 level1 lfo5;tab-stops:list .5in'>Self-signed certificate </li>

file. There is a sample configuration file that comes with the OpenSSL

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

package.

mso-list:l5 level1 lfo5;tab-stops:list .5in'>Certificate issued by a

third-party certificate authority</li>

<ul>

</ul>

<li>To generate a private key, execute the following:

openssl genrsa -out

To generate a self-signed certificate, you must create a private key, a

myserver.key 1024

certificate signing request (CSR), and finally the public x509 certificate. You

Set the "sslKeyFilePath" configuration property to point to this key

also need an SSL configuration file that defines the parameters of the

file. </li>

Distinguished Name (DN). You can use the one that comes with Pegasus, <span

<li>To generate a certificate signing request, execute the following:

class=SpellE>ssl.cnf in the root directory, or generate your own. For a

openssl req -config

self-signed certificate, the subject is the same as the issuer. Execute the

openssl.cnf -new -key myserver.key -out myserver.csr

following commands to create a self-signed certificate. The PEGASUS_ROOT and

</li>

PEGASUS_HOME have to be set to your respective installation and source

<li> At this point, the certificate signing request can be sent out

directory. You will also need an OpenSSL

to a third-party certificate authority for signing, or a self-signed

configuration file. There is a sample configuration file that comes with the <span

certificate can be generated. To generate a self-signed certificate,

class=SpellE>OpenSSL package.

execute the following:

openssl x509 -in myserver.csr

-out myserver.cert -req -signkey myserver.key -days 365

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

Set the "sslCertificateFilePath" configuration property to point to

mso-list:l12 level1 lfo6;tab-stops:list .5in'>To generate a private key,

this certificate file. The above CSR file can be discarded after the

execute the following:

certificate is created.

openssl<span

style='font-family:Courier;color:#009900'> genrsa

-out myserver.key 1024

Set the "sslKeyFilePath" configuration

property to point to this key file. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l12 level1 lfo6;tab-stops:list .5in'>To generate a certificate

signing request, execute the following:

openssl<span

style='font-family:Courier;color:#009900'> req -<span

class=SpellE>config openssl.cnf -new -key

myserver.key -out myserver.csr

</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l12 level1 lfo6;tab-stops:list .5in'>At this point, the

certificate signing request can be sent out to a third-party certificate

authority for signing, or a self-signed certificate can be generated. To

generate a self-signed certificate, execute the following<span

class=GramE>:

openssl<span

style='font-family:Courier;color:#009900'> x509 -in myserver.csr

-out myserver.cert -req

-signkey myserver.key

-days 365

Set the "sslCertificateFilePath"

configuration property to point to this certificate file. The above CSR

file can be discarded after the certificate is created. </li>

</ul>

After creating the keypair, make sure you protect

After creating the keypair, make sure you protect the information

the information sufficiently by changing permissions on the files and/or

sufficiently by changing permissions on the files and/or directories.

directories. The following table shows the recommended privileges:

The following table shows the recommended privileges:

<table class=MsoNormalTable border=1 cellspacing=1 cellpadding=0 width="30%"

style='width:30.0%;mso-cellspacing:.7pt'>

<tbody>

<tr>

SSL file<o:p></o:p>

</td>

<th>Pegasus Config property</th>

<th>Permissions</th>

Pegasus <span

class=SpellE>Config property<o:p></o:p>

</td>

Permissions<o:p></o:p>

</td>

</tr>

<tr>

<td>Private key</td>

Private key

<td>sslKeyFilePath</td>

</td>

sslKeyFilePath

</td>

rwx------

</td>

</tr>

<tr>

<td>Public certificate</td>

Public certificate

<td>sslCertificateFilePath</td>

</td>

sslCertificateFilePath

</td>

rwxr-xr-x

</td>

</tr>

<tr>

<td>Truststore</td>

Truststore

<td>sslTrustStore</td>

</td>

sslTrustStore

</td>

rwxr-xr-x

</td>

</tr>

<tr>

<td>CRL store </td>

CRL store

<td>crlStore</td>

</td>

crlStore

</td>

rwxr-xr-x

</td>

</tr>

</tbody>

</table>

The administrator is responsible for ensuring that the above file

permissions are set correctly. The administrator should also ensure that all

permissions are set correctly. The administrator should also ensure

containing directories all the way up to the base directory are not

that all containing directories all the way up to the base directory

world-writable. Pegasus only checks the following conditions when starting up:

are not world-writable. Pegasus only checks the following conditions

when starting up:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<ul>

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslKeyFilePath

<li>The sslKeyFilePath and the sslCertificateFilePath are readable by

and the sslCertificateFilePath are readable by

the CIMOM. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li>The sslTrustStore and crlStore are readable

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslTrustStore

by the CIMOM if they are a single file.</li>

and crlStore are readable by the CIMOM if they

<li>The sslTrustStore and crlStore are readable

are a single file. </li>

and writable by the CIMOM if they are a directory.</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

</ul>

mso-list:l1 level1 lfo7;tab-stops:list .5in'>The sslTrustStore

and crlStore are readable and writable by the

These same file permissions should be used for protecting a client's

CIMOM if they are a directory.</li>

private key, public key, truststore, and crl store as well.

</ul>

For more information on generating keys and certificates, consult

These same file permissions should be used for protecting a client's private

the <a href="http://www.openssl.org/docs/HOWTO/">OpenSSL HOW-TO

key, public key, truststore, and crl

documentation</a>.

store as well.

<h3><a name="CONFIGURE">Configuring Pegasus for SSL</a></h3>

There are many environment variable settings associated with SSL. Here

For more information on generating keys and certificates, consult the <a

is a brief discussion of the subtleties of these options and how they

href="http://www.openssl.org/docs/HOWTO/">OpenSSL

work together to

HOW-TO documentation</a>.

create a more secure environment. More information on the default and

recommended settings can be found in PEP#200 Recommended OpenPegasus

<h3><a name=CONFIGURE>Configuring Pegasus for SSL</a></h3>

2.5 Build and Configuration Options for Selected Platforms.

Additionally, the section on <a href="#DESIGN">Design Question List</a>

There are many environment variable settings associated with

should help determine what these settings should be for a given

SSL. Here is a brief discussion of the subtleties of these options and how they

application.

work together to create a more secure environment. More information on the

enableHttpsConnection

default and recommended settings can be found in PEP#200 Recommended <span

This is disabled by default on most platforms. It is recommended that

class=SpellE>OpenPegasus 2.5 Build and Configuration Options for

all remote communication be done over the HTTPS port. However, if you

Selected Platforms. Additionally, the section on <a href="#DESIGN">Design

are sending cleartext passwords over the wire, it is imperative that

Question List</a> should help determine what these settings should be for a

you only use the secure port. For added security, the HTTP port can be

given application.

disabled to prevent clients from connecting to it. The HTTPS connection

is enabled by default only on the following platforms:

enableHttpsConnection

This is disabled by default on most platforms. It is recommended that all

remote communication be done over the HTTPS port. However, if you are sending <span

<ul>

class=SpellE>cleartext passwords over the wire, it is imperative that

<li>LINUX</li>

you only use the secure port. For added security, the HTTP port can be disabled

to prevent clients from connecting to it. The HTTPS connection is enabled by

<li>HP_UX (if PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</li>

default only on the following platforms:

<li>VMS (if PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>LINUX </li>

httpsPort

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>OS-400 </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>HP_UX (if

PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true) </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l6 level1 lfo8;tab-stops:list .5in'>VMS (if

PEGASUS_USE_RELEASE_CONFIG_OPTIONS is true)</li>

</ul>

httpsPort

The default setting is 5989, the official WBEM secure port.

sslCertificateFilePath

sslCertificateFilePath

This is the path to the x509 server certificate. The server certificate

may be a chain in which case the file should contain PEM encoded

This is the path to the x509 server certificate. The server certificate may be

certificates beginning with the server certificate and followed by each

a chain in which case the file should contain PEM encoded certificates

signing certificate authority (CA) including the root CA. If the server

beginning with the server certificate and followed by each signing certificate

certificate is a self signed certificate, the file only contains the

authority (CA) including the root CA. If the server certificate is a self

self-signed certificate in PEM format.

signed certificate, the file only contains the self-signed certificate in PEM

The certificate cannot be encrypted because there is currently no

format. The certificate cannot be encrypted because there is currently no

mechanism for decrypting the certificate using a user-supplied

mechanism for decrypting the certificate using a user-supplied password. This

password. This property must be defined if enableHttpsConnection is

property must be defined if enableHttpsConnection is

true. Any failure in finding this file will result in the cimserver

true. Any failure in finding this file will result in the cimserver

failing to start. See <a href="#CERTS">Creating SSL Certificates</a>

failing to start. See <a href="#CERTS">Creating SSL Certificates</a> for more

for more information.

information.

sslKeyFilePath

This is the path to the server's private key. All keys should be at least 1024

bytes long. This property must be defined if enableHttpsConnection

is true. Any failure in finding this file will result in the <span

class=SpellE>cimserver failing to start. See <a href="#CERTS">Creating

SSL Certificate</a> for more information.

sslClientVerificationMode

This setting controls how the cimserver (i.e. the

HTTPS port) is configured. There are three possible settings: disabled,

required, optional. There is no "right" setting for this property.

The default is disabled and it is fine to leave the setting as disabled if you

are going to use basic authentication to authenticate all client requests. In

many applications where a physical person is there to supply a username and

password, basic authentication is sufficient. Other environments may be

heterogeneous, in which case it makes sense to allow both basic authentication

and SSL certificate verification. The setting of this variable also impacts

what happens during the OpenSSL handshake:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"required"

-- The server requires that the client certificate be trusted in order for

the handshake to continue. If the client fails to send a certificate or

sends an untrusted certificate, the handshake is

immediately terminated. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"optional"

-- The server will request that a client certificate be sent, but will

continue the handshake even if no certificate is received. If

authentication is enabled, the server will seek to authenticate the client

via an alternative method of authentication. As

of 2.5.1, if a certificate is sent but it is not validated, the handshake

will fail. Before 2.5.1,the handshake would

have continued and basic authentication would have proceeded. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l4 level1 lfo9;tab-stops:list .5in'>"disabled"

-- The server will not prompt the client for a certificate. This is the

default.</li>

</ul>

Pegasus currently ties a certificate to a valid OS user.

Multiple certificates may be registered to the same user. When a certificate is

authenticated, Pegasus views it in the same way as if a user was authenticated

via basic authentication. The providers receive the username that the

certificate was mapped to. See the SSL Authorization section for more

information.

sslTrustStore

This setting controls the truststore for the <span

class=SpellE>cimserver's HTTPS connection. It can be either a directory

or a single root CA file. When set to a directory, it is recommended that you

use the cimtrust CLI to populate the <span

class=SpellE>truststore as there are strict naming requirements for

trusted certificate files. See the <a href="#CLI">cimtrust

& cimcrl CLI</a> section for further information.

sslKeyFilePath

sslTrustStoreUserName

This is the path to the server's private key. All keys should be at

This setting is only utilized if the sslTrustStore is

least 1024 bytes long. This property must be defined if

a single CA file. It is not used if the sslTrustStore

enableHttpsConnection is true. Any failure in finding this file will

setting is a directory, but it still must be set to a valid system user. This

result in the cimserver failing to start. See <a href="#CERTS">Creating

is because the validation of the property is done independently of the <span

SSL Certificate</a> for more information.

class=SpellE>sslTrustStore setting. This property represents the valid

OS user that corresponds to the root certificate. All requests authenticated

sslClientVerificationMode

with a certificate under the root CA will be associated with this user and the

This setting controls how the cimserver (i.e. the HTTPS port) is

username will be propagated to providers. If applications desire for there to

configured. There are three possible settings: disabled, required,

be a one-to-one correspondence between users and certificates, it is

optional. There is no "right" setting for this property. The default is

recommended that each certificate be registered individually using the <a

disabled and it is fine to leave the setting as disabled if you are

href="#CLI">cimtrust CLI</a>.

going to use basic authentication to authenticate all client requests.

In many applications where a physical person is there to supply a

crlStore

username and password, basic authentication is sufficient. Other

This is where the CRL (Certificate Revocation List) store resides. It is important

environments may be heterogeneous, in which case it makes sense to

to note that certificates are checked first against the CRL (if specified) and

allow both basic authentication and SSL certificate verification. The

then against the server truststore. The <a href="#CLI"><span

setting of this variable also impacts what happens during the OpenSSL

class=SpellE>cimcrl CLI</a> should be used for CRL management.

handshake:

<ul>

<li>"required" -- The server requires that the client

certificate be trusted in order for the handshake to continue. If the

client fails to send a certificate or sends an untrusted certificate,

the handshake is immediately terminated.</li>

<li>"optional" -- The server will request that a client

certificate be sent, but will continue the handshake even if no

certificate is received. If authentication is enabled, the server will

seek to authenticate the client via an alternative method of

authentication. As

of 2.5.1, if a certificate is sent but it is not validated, the

handshake will fail. Before 2.5.1,the handshake would have

continued and basic authentication would have proceeded. </li>

<li>"disabled" -- The server will not prompt the client for a

certificate. This is the default.</li>

</ul>

Pegasus currently ties a certificate to a valid OS user. Multiple

certificates may be registered to the same user. When a certificate is

authenticated, Pegasus views it in the same way as if a user was

authenticated via basic authentication. The providers

receive the username that the certificate was mapped to. See the SSL

Authorization section

for more information.

sslTrustStore

This setting controls the truststore for the cimserver's HTTPS

connection. It can be

either a directory or a single root CA file. When set to a directory,

it is recommended that you use the cimtrust CLI to populate the

truststore as there are strict naming requirements for trusted

certificate files. See the <a href="#CLI">cimtrust & cimcrl CLI</a>

section for further information.

sslTrustStoreUserName

This setting is only utilized if the sslTrustStore is a single CA file.

It is not used if the sslTrustStore setting is a directory, but it

still must be set to a valid system user. This is because the

validation of the property is done independently of the sslTrustStore

setting. This property represents the valid OS user that corresponds to

the root certificate. All requests authenticated with a certificate

under the root CA will be associated with this user and the username

will be propagated to providers. If applications desire for there to be

a one-to-one correspondence between users and certificates, it is

recommended that each certificate be registered individually using the

<a href="#CLI">cimtrust CLI</a>.

crlStore

This is where the CRL (Certificate Revocation List) store resides.

It is important to note that certificates are

checked first against the CRL (if specified) and then against the

server truststore. The <a href="#CLI">cimcrl CLI</a> should be used for

CRL management.

<h4>Configuration Limitations</h4>

The following are configuration limitations:

The following are configuration limitations:

<ul>

<li>The x509 server certificate file cannot be encrypted. The reason

for this is that there is currently no mechanism in Pegasus to grab the

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

password needed to unencrypt it. Therefore, the best way to secure the

mso-list:l2 level1 lfo10;tab-stops:list .5in'>The x509 server certificate

file is to follow the file permissions settings specified in <a

file cannot be encrypted. The reason for this is that there is currently

href="#CERTS">Creating SSL Certificates.</a></li>

no mechanism in Pegasus to grab the password needed to unencrypt

<li>There is no property to specify supported cipher lists at this

it. Therefore, the best way to secure the file is to follow the file

time. Pegasus uses the default OpenSSL cipher list. The cipher lists

permissions settings specified in <a href="#CERTS">Creating SSL

can be found at <a

Certificates.</a> </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l2 level1 lfo10;tab-stops:list .5in'>There is no property to

specify supported cipher lists at this time. Pegasus uses the default <span

class=SpellE>OpenSSL cipher list. The cipher lists can be found at <a

href="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</a>

and <a

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a>

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a></li>

</li>

<li>The verification depth cannot be specified. Pegasus uses the

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

default OpenSSL depth of 9. This means the OpenSSL will only accept

mso-list:l2 level1 lfo10;tab-stops:list .5in'>The verification depth

client certificate chains up to 9 levels deep.</li>

cannot be specified. Pegasus uses the default OpenSSL

<li>No hostname checking is performed to ensure that the subject

depth of 9. This means the OpenSSL will only

field of the distinguished name (DN) matches the hostname.</li>

accept client certificate chains up to 9 levels deep. </li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<h3><a name="DESIGN">SSL Design Question List</a></h3>

mso-list:l2 level1 lfo10;tab-stops:list .5in'>No hostname checking is

The following questions may be helpful in determining how to

performed to ensure that the subject field of the distinguished name (DN)

configure Pegasus CIM Server.

matches the hostname.</li>

Should I enable the HTTPS port?

</ul>

Yes, especially if you are sending passwords with requests. The HTTP

port can be disabled for additional security if desired.

<h3><a name=DESIGN>SSL Design Question List</a></h3>

Should I configure the CIMOM to use a truststore?

The following questions may be helpful in determining how to configure

This depends on the infrastructure of the application. If all clients

Pegasus CIM Server.

are using basic authentication over the secure port

(and the passwords are secured), then a truststore may not be needed.

Should I enable the HTTPS port?

If an application does not want to store user/pw information,

Yes, especially if you are sending passwords with requests. The HTTP port can

then it is a good idea to use a certificate-based infrastructure. If a

be disabled for additional security if desired.

CIMOM certificate is compromised, the cimserver and the providers

Should I configure the CIMOM to use a truststore?

of the system are compromised. The severity of this scenario is

This depends on the infrastructure of the application. If all clients are using

dependent on the resources the providers have access to. If an OS

basic authentication over the secure port (and the passwords are secured), then

password is compromised, the entire system may be compromised.

a truststore may not be needed. If an application

If using peer verification, it is important to ensure that 1) the

does not want to store user/pw information, then it

cimserver is properly configured to use a truststore,

is a good idea to use a certificate-based infrastructure. If a CIMOM

2) the truststore is loaded properly and protected, and 3)

certificate is compromised, the cimserver and the

authorization checks are performed after a certificate is verified.

providers of the system are compromised. The severity of this scenario is

These same conditions also apply to a client that is verifying a server.

dependent on the resources the providers have access to. If an OS password is

Should I use a self-signed certificate or one issued by a

compromised, the entire system may be compromised. If using peer verification,

third-party certificate authority?

it is important to ensure that 1) the cimserver is

Generally, scalability will determine whether it's appropriate to use a

properly configured to use a truststore, 2) the <span

self-signed certificate or one issued by Verisign

class=SpellE>truststore is loaded properly and protected, and 3)

or another third-party certificate authority.

authorization checks are performed after a certificate is verified. These same

If an administrator administrates their self-signed certificates

conditions also apply to a client that is verifying a server.

correctly, they are no less secure than one issued by a CA. What a CA

Should I use a self-signed certificate or one issued by a third-party

buys you is scalability. An up front cost of setting up a CA

certificate authority?

Generally, scalability will determine whether it's appropriate to use a self-signed

certificate or one issued by Verisign or another

third-party certificate authority. If an administrator administrates their

self-signed certificates correctly, they are no less secure than one issued by

a CA. What a CA buys you is scalability. An up front cost of setting up a CA

relationship will be offset by the convenience of having that CA

"vouch" for certs it has signed, in large

"vouch" for certs it has signed, in large deployments. In small

deployments. In small deployments the incremental cost might never outweigh the

deployments the incremental cost might never outweigh the initial

initial CA-setup cost.

CA-setup cost.

One important thing to remember is that you should not use the same certificate

One important thing to remember is that you should not use the same

for multiple CIMOMs. If using a self-signed

certificate for multiple CIMOMs. If using a self-signed certificate, a

certificate, a different one should be generated for each CIMOM, using some

different one should be generated for each CIMOM, using some unique

unique piece of data to make them different. That way, if one of the

piece of data to make them different. That way, if one of the

certificates is compromised, the other ones remain secure.

Should the truststore be a single root CA file or

Should the truststore be a single root CA file or a directory?

a directory?

If you only anticipate connections from a narrowly defined set of

If you only anticipate connections from a narrowly defined set of clients, then

clients, then a single root CA certificate file should be sufficient.

a single root CA certificate file should be sufficient. Alternatively, multiple

Alternatively, multiple trusted certificates may be stored in PEM

trusted certificates may be stored in PEM format inside of a single CA file. If

format inside of a single CA file.

you anticipate getting requests from a heterogeneous set of clients, then it

If you anticipate getting requests from a heterogeneous set of clients,

probably makes sense to use the directory option to allow flexibility in the

then it probably makes sense to use the directory option to allow

future. In the latter scenario, the same single root CA file can still be used

flexibility in the future. In the latter scenario, the same single root

with the additional step of using cimtrust to

CA file can still be used with the additional step of using cimtrust

to register it.

user can be associated with ALL certificates under that CA. Following the

It's important to note that when registering a root CA, only one user

principle of least privilege, it is not a good idea to register a root CA to a

can be associated with ALL certificates under that CA. Following the

privileged user if lesser privileged users will be connecting with it.

principle of

How do I protect the keystore and the <span

least privilege, it is not a good idea to register a root CA to a

class=SpellE>truststore?

privileged user if lesser privileged users will be connecting with it.

The server's private key should always be protected; it is private for a

reason. Only the system administrator should be able to see it. The public

How do I protect the keystore and the truststore?

certificate can be viewed by anyone, however, it

The server's private key should always be protected; it is private for

should be protected from alteration by system users. Similarly, any <span

a reason. Only the system administrator should be able to see it. The

class=SpellE>truststore or CRL file or directory should also be

public certificate can be viewed by anyone, however, it should be

protected from alteration. See <a href="#CERTS">Creating SSL Certificates</a>

protected from alteration by system users. Similarly, any truststore or

for the recommended file privileges.

CRL file or directory should also be protected from alteration. See <a

href="#CERTS">Creating SSL Certificates</a> for the recommended file

privileges.

When do I need to use a CRL?

Certificate Revocation Lists are regularly issued by CA's. They contain a list

Certificate Revocation Lists are regularly issued by CA's. They contain

of certificates that have been revoked. Any application using a CA certificate

a list of certificates that have been revoked. Any application using a

in its truststore should also implement <span

CA certificate in its truststore should also implement CRLs (if the CA

class=SpellE>CRLs (if the CA supports them). Pegasus itself does not

supports them). Pegasus itself

check CRL validity dates during startup. Therefore, it is the responsibility of

does not check CRL validity dates during startup. Therefore, it is the

the administrator to regularly download or acquire the CRL and import it into

responsibility of the administrator

the CRL store using the <a href="#CLI">cimcrl CLI</a>.

to regularly download or acquire the CRL and import it into the CRL

CRLs<span

store using the <a href="#CLI">cimcrl CLI</a>.

style='color:black'> are not checked for expiration during the SSL callback.

CRLs are not checked

This means that if a CRL for a particular issuer has expired, Pegasus still

for expiration during the SSL callback. This means that if a CRL for a

accepts certificates from the issuer and uses the expired CRL as the latest.

particular issuer has expired,

Again, it is the responsibility of the administrator to ensure the CRL is up to

Pegasus still accepts certificates from the issuer and uses the expired

date. CRLs are not checked for critical extensions

CRL as the latest. Again, it is the responsibility of the administrator

during CRL verification. If a CRL contains a critical extension it will be

to ensure the CRL is up to date. CRLs are not checked for critical

ignored.

extensions during CRL verification. If a CRL contains a critical

If using self-signed certificates, however, a CRL is most likely not needed

extension it will be ignored.

(You can create a self-signed CRL but it is not really necessary). Because of

this, the certificate deletion option available via cimtrust

If using self-signed certificates, however, a CRL is most likely not

is primarily intended for self-signed certificates. Technically, <span

needed (You can create a self-signed CRL but it is not really

class=SpellE>CRL's are the correct way to revoke compromised or invalid

necessary). Because of this, the certificate deletion option available

certificates.

via cimtrust is primarily intended for self-signed certificates.

Technically, CRL's are the correct way to revoke compromised or invalid

certificates.

What is the order of operations for certificate verification?

The certificate is checked against any CRLs first

The certificate is checked against any CRLs first before going through

before going through the rest of the verification process. Verification starts

the rest of the verification process. Verification starts with the

with the root certificate and continues down to the peer certificate. If

root certificate and continues down to the peer certificate. If

verification fails at any of these points, the certificate is considered <span

verification fails at any of these points, the certificate is

class=SpellE>untrusted and the verification process reports an error.

considered

untrusted and the verification process reports an error.

<h3><a name=TRUSTSTORE></a>Truststore<span

<h3><a name="TRUSTSTORE">Truststore Management</a></h3>

style='mso-bookmark:TRUSTSTORE'> Management</h3>

There are two directions of trust in an SSL client-server handshake:

The client trusts the server. The server trusts the client. Pegasus

There are two directions of trust in an SSL client-server

provides a way to implement one or both of these relationships.

handshake: The client trusts the server. The server trusts the client. Pegasus

Ideally, an application should support both levels of trust for maximum

provides a way to implement one or both of these relationships. Ideally, an

security and this is the implementation Pegasus recommends. However, in

application should support both levels of trust for maximum security and this

some scenarios it may make sense to only implement one of these; in

is the implementation Pegasus recommends. However, in some scenarios it may

that case, it is possible to override the client or the server to

make sense to only implement one of these; in that case, it is possible to override

"trust all certificates." For example, if all clients will be using

the client or the server to "trust all certificates." For example, if

basic authentication over HTTPS, then the server can be setup to "trust

all clients will be using basic authentication over HTTPS, then the server can

all client certificates."

be setup to "trust all client certificates."

To tell the cimserver to require that all clients be trusted,

simply set the sslClientVerification<font style="color: rgb(0, 0, 0);"

To tell the cimserver to require that all clients

color="MAGENTA">Mode property to "required."

be trusted, simply set the sslClientVerification<span

To tell the cimserver to trust all clients, set the

style='color:black'>Mode property to "required."

sslClientVerificationMode

To tell the cimserver to trust all clients, set the <span

property to "disabled" or "optional".

class=SpellE>sslClientVerificationMode

property to "disabled" or "optional".

The SSL verification in Pegasus is independent of any other

authentication mechanism. It can still be utilized when authentication

The SSL verification in Pegasus is independent of any other authentication

is disabled.

mechanism. It can still be utilized when authentication is disabled. When

When authentication is enabled, the first line of defense is SSL client

authentication is enabled, the first line of defense is SSL client

verification.

verification. In situations where a client is not

In situations where a client is not authenticated by SSL because the

authenticated by SSL because the client sent no certificate and the setting is

client sent no certificate and the setting is "optional", the server

"optional", the server will attempt to authenticate the client via

will attempt to authenticate the client via another method of

another method of authentication . In this case, the

authentication . In this case, the authentication mechanism specified

authentication mechanism specified by the configuration property "<span

by the configuration property "httpAuthType" will be used for remote

class=SpellE>httpAuthType" will be used for remote connections and

connections and local authentication will be used for local

local authentication will be used for local connections. In situations where a

connections.

client is not authenticated by SSL because the client certificate was invalid,

In situations where a client is not authenticated by SSL because the

the handshake will be terminated.

client certificate was invalid, the handshake will be terminated.

Note: Before 2.5.1, in the latter case, authentication would have proceeded

Note: Before 2.5.1, in the latter case, authentication would have

in the same way as if the client had sent no certificate. To enable the legacy

proceeded in the same way as if the client had sent no certificate. To

behavior, the compile-time flag PEGASUS_OVERRIDE_SSL_CERT_VERIFICATION_RESULT

enable the legacy behavior, the compile-time flag

should be defined.

PEGASUS_OVERRIDE_SSL_CERT_VERIFICATION_RESULT should be defined.

See the <a href="#CLIENT">Configuring the Pegasus CIM Client for SSL</a>

section below on how to setup the client's truststore.

section below on how to setup the client's truststore.

<h3><a name="CLI">cimtrust & cimcrl CLI</a></h3>

<h3><a name=CLI></a><span

cimtrust CLI may be used to add, remove or list X509 certificates in a

style='mso-bookmark:CLI'>cimtrust<span style='mso-bookmark:

PEM format truststore. cimcrl CLI may be used to add, remove or list

CLI'> & cimcrl CLI</h3>

X509 Certificate Revocation Lists in a PEM format CRL store.

cimtrust

The CLIs interface with a Certificate control provider that runs as

CLI may be used to add, remove or list X509 certificates in a PEM format <span

part of Pegasus's core. It operates on the PG_SSLCertificate and

class=SpellE>truststore. cimcrl

PG_SSLCertificateRevocationList classes in root/PG_Internal.

CLI may be used to add, remove or list X509 Certificate Revocation Lists in a

It is recommended that the CLIs be used in place of manual

PEM format CRL store. The CLIs interface with a

configuration for several reasons:

Certificate control provider that runs as part of Pegasus's core. It operates

<ul>

on the PG_SSLCertificate and PG_SSLCertificateRevocationList

<li>OpenSSL places strict naming restrictions on certificates and

classes in root/PG_Internal. It is recommended that

CRLs in a directory (the files are looked up via a subject hash code)</li>

the CLIs be used in place of manual configuration for

<li>Certificate instances are stored in the repository along with the

several reasons:

corresponding username. If the certificate is not properly registered,

the username mapping will fail. <span

style="color: rgb(0, 0, 0);">cimtrust CLI supports the

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

ability to register a certificate without a username for root

mso-list:l13 level1 lfo11;tab-stops:list .5in'>OpenSSL

certificates and intermediate certificates, since these certificates

places strict naming restrictions on certificates and CRLs

represent a collection of users. In this scenario, each leaf

in a directory (the files are looked up via a subject hash code) </li>

certificate must be registered to an individual user. See the

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

Authorization section for more information on username validation.

mso-list:l13 level1 lfo11;tab-stops:list .5in'>Certificate instances are

</li>

stored in the repository along with the corresponding username. If the

<li>The CLIs,

certificate is not properly registered, the username mapping will fail.<span

or more correctly the provider they operate on, supports dynamic

style='color:fuchsia'> <span

deletion of certificates by resetting the cimserver's SSL context.

style='color:black'>cimtrust

Normally, you would need to stop and start the cimserver to

CLI supports the ability to register a certificate without a username for

accomplish this.</li>

root certificates and intermediate certificates, since these certificates

<li>The CLIs, or more correctly the provider they operate on, performs

represent a collection of users. In this scenario, each leaf certificate

a ton of error checking you would not get by manually configuring the

must be registered to an individual user. See the Authorization section

stores. This alerts the administrator to various error conditions (e.g.

for more information on username validation. </li>

the certificate expired) associated with a certificate or CRL.</li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

</ul>

mso-list:l13 level1 lfo11;tab-stops:list .5in'>The

The CIMOM must be up and running while executing cimtrust/cimcrl CLI. The

CLIs, or more correctly the provider they

cimtrust and cimcrl manpages provide more information on commands and syntax.

operate on, supports dynamic deletion of certificates by resetting the <span

<h3><a name="CLIENT">Configuring the Pegasus CIM Client for SSL</a></h3>

class=SpellE>cimserver's SSL context.<span style='color:

A Pegasus CIM client can be configured to use SSL by using a

fuchsia'> Normally, you would need to stop and start the <span

constructor that takes an SSLContext. The construction of the

class=SpellE>cimserver to accomplish this. </li>

SSLContext is really what controls the behavior of the client during

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

the SSL handshake. Without going into minute details about what happens

mso-list:l13 level1 lfo11;tab-stops:list .5in'>The CLIs,

under the covers, here is a description of the various SSLContext

or more correctly the provider they operate on, performs a ton of error

constructor parameters.

checking you would not get by manually configuring the stores. This alerts

Here's a code snippet that shows how to call a client constructor

the administrator to various error conditions (e.g. the certificate

that connects to a server over SSL and can present its own trusted

expired) associated with a certificate or CRL.</li>

certificate if the server requests it. In this scenario, the client

</ul>

also checks the server certificate against its truststore and specifies

an additional callback in addition to the default one (the

The CIMOM must be up and running while executing <span

user-specified callback is optional and can be set to null).

class=SpellE>cimtrust/cimcrl CLI. The cimtrust

and cimcrl manpages provide

<ul>

more information on commands and syntax.

client.connect( hostname, port, SSLContext(trustStore,

certPath, keyPath, verifyCert, randomFile), username, password);

<h3><a name=CLIENT>Configuring the Pegasus CIM Client for SSL</a></h3>

</ul>

A Pegasus CIM client can be configured to use SSL by using a constructor

Here's a code snippet that shows how to call a client constructor

that takes an SSLContext. The construction of the <span

that connects to a server over SSL and does not possess its own trusted

class=SpellE>SSLContext is really what controls the behavior of the

certificate. In this scenario, the client also checks the server

client during the SSL handshake. Without going into minute details about what

certificate against its truststore.

happens under the covers, here is a description of the various <span

class=SpellE>SSLContext constructor parameters.

<ul>

client.connect( hostname, port, SSLContext(trustStore,

Here's a code snippet that shows how to call a client constructor that

NULL, randomFile), username password);

connects to a server over SSL and can present its own trusted certificate if

</ul>

the server requests it. In this scenario, the client also checks the server

certificate against its truststore and specifies an

<ul>

additional callback in addition to the default one (the user-specified callback

<li>trustStore -- This specifies the truststore that the

is optional and can be set to null).

client uses to verify server certificates. It can be String::EMPTY if

no truststore exists. </li>

<span

<li>certPath -- This specifies the x509 certificate of the

class=GramE>client.connect<span

client that will be sent during an SSL handshake. Note that this

class=GramE>(<span

certificate will only be sent if the server requests it. If this option

style='font-family:Courier'> hostname, port, SSLContext(<span

is specified, the keyPath parameter must also be specified.</li>

class=SpellE>trustStore, certPath, <span

<li>keyPath -- This specifies the private key of the client.

class=SpellE>keyPath, verifyCert, <span

If this option is specified, the certPath parameter must also be

class=SpellE>randomFile), username, password);

specified.</li>

<li>crlPath -- This specifies an optional CRL store path. The

Here's a code snippet that shows how to call a client constructor that

client checks the CRL list first, before attempting any further

connects to a server over SSL and does not possess its own trusted certificate.

authentication, including the user-specified callback.</li>

In this scenario, the client also checks the server certificate against its <span

<li>verifyCert -- This is a user-specified verification

class=SpellE>truststore.

callback. If this is set to null, the default OpenSSL verification

callback will be executed. You can implement this method to "trust all

<span

servers" or to perform additional authentication checks that OpenSSL

class=GramE>client.connect<span

class=GramE>(<span

style='font-family:Courier'> hostname, port, SSLContext(<span

class=SpellE>trustStore, NULL, randomFile),

username password);

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>trustStore -- This specifies the <span

class=SpellE>truststore that the client uses to verify server

certificates. It can be String::EMPTY if no <span

class=SpellE>truststore exists. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>certPath -- This specifies the x509

certificate of the client that will be sent during an SSL handshake. Note

that this certificate will only be sent if the server requests it. If this

option is specified, the keyPath parameter must

also be specified. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>keyPath -- This specifies the private key

of the client. If this option is specified, the certPath

parameter must also be specified. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>crlPath -- This specifies an optional CRL

store path. The client checks the CRL list first, before attempting any

further authentication, including the user-specified callback. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

class=GramE>verifyCert -- This is a user-specified

verification callback. If this is set to null, the default <span

class=SpellE>OpenSSL verification callback will be executed. You

can implement this method to "trust all servers" or to perform

additional authentication checks that OpenSSL

does not perform by default. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

<li>randomFile -- A file to seed the pseudo random number

mso-list:l3 level1 lfo14;tab-stops:list .5in'><span

generator (PRNG).</li>

class=GramE>randomFile -- A file to seed the pseudo

random number generator (PRNG).</li>

</ul>

Here are some general guidelines on implementing peer verification for the

client:

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should enable

peer verification by specifying a truststore and

(optionally) a user-specified callback function. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should employ a <span

class=SpellE>truststore in order to properly verify the server. The

truststore should contain a file or directory of

trusted CA certificates. The cimtrust CLI cannot

be used to configure client truststores. The

trusted certificate(s) should be placed in a protected file or directory

specified by the trustStore parameter. Keep in

mind that the SSL context generally has to be reloaded to pick up any <span

class=SpellE>truststore changes. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client could also use a

user-specified callback in addition to the default verification callback,

if additional verifications are desired over the normal checks that <span

class=SpellE>OpenSSL performs. In most cases, the default

verification callback is sufficient for checking server certificates. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should ensure

that adequate entropy is attained. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should use a CRL

store if the truststore contains CA certificates

that support one. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should only use

the SSLv3 and TLSv1 protocols. By default, Pegasus is not built with SSLv2

support. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

mso-list:l11 level1 lfo15;tab-stops:list .5in'>The client should perform

post-connection checks. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Ensure a certificate

was received. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>WARNING:  In

some implementations of SSL a NULL server certificate is perfectly valid

and authenticates against all trust stores.  If the client does not

ensure a certificate exists then the client is not providing server

authentication and could have a security bulletin class defect.</li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Validate that the

certificate received was issued to the host for which the client was attempting

to connect. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>Ensure that the

common name (CN) in the server�s certificate subject matches the host

name of the server.  For X509v3 certificates, the �<span

class=SpellE>SubjectAltName� fields in

the certificate's extended attributes are also valid host names for the

certificate. </li>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

auto;mso-list:l11 level3 lfo15;tab-stops:list 1.5in'>WARNING:  If

the client does not ensure the host name of the server is the same as

one of the host names explicitly described in the server�s certificate,

you have not authenticated the server�s identity.  Any other server

which was issued a certificate from the same trusted CA can masquerade

as the server unless the client performs the host name check.</li>

</ul>

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:

Here are some general guidelines on implementing peer verification

auto;mso-list:l11 level2 lfo15;tab-stops:list 1.0in'>Ensure that

for the client:

certificate verification methods/routines return no errors.</li>

</ul>

<ul>

</ul>

<li>The client should enable peer verification by specifying a

truststore and (optionally) a user-specified callback function.</li>

Because only the above arguments can be passed into the Pegasus <span

<li>The client should employ a truststore in order to properly verify

class=SpellE>SSLContext, there are some limitations in the client

the server. The truststore should contain a file or directory of

configuration:

trusted CA certificates. The cimtrust CLI cannot be used to

configure client truststores. The trusted certificate(s) should be

placed in a protected file or directory specified by the trustStore

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

parameter. Keep in mind that the SSL context generally has to be

mso-list:l10 level1 lfo16;tab-stops:list .5in'>The verification depth

reloaded to pick up any truststore changes.</li>

cannot be specified. Pegasus uses the default OpenSSL

<li>The client could also use a user-specified callback in addition

depth of 9. </li>

to the default verification callback, if additional verifications are

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

desired over the normal checks that OpenSSL performs. In most cases,

mso-list:l10 level1 lfo16;tab-stops:list .5in'>The cipher list cannot be

the default verification callback is sufficient for checking server

specified. Pegasus uses the default OpenSSL

certificates.</li>

cipher list. The cipher lists can be found at <a

<li>The client should ensure that adequate entropy is attained.</li>

<li>The client should use a CRL store if the truststore contains CA

certificates that support one.</li>

<li>The client should only use the SSLv3 and TLSv1 protocols. By

default, Pegasus is not built with SSLv2 support.</li>

<li>The client should perform post-connection checks. </li>

<ul>

<li>Ensure a certificate was received.</li>

<ul>

<li>WARNING:  In some implementations of SSL a NULL server

certificate is perfectly valid and authenticates against all trust

stores.  If the client does not ensure a certificate exists then

the client is not providing server authentication and could have a

security bulletin class defect.</li>

</ul>

<li>Validate that the certificate received was issued to the host

for which the client was attempting to connect.</li>

<ul>

<li>Ensure that the common name (CN) in the server’s certificate

subject matches the host name of the server.  For X509v3

certificates, the “SubjectAltName” fields

in the certificate's extended attributes are also valid host names for

the certificate. </li>

<li>WARNING:  If the client does not ensure the host name of

the server is the same as one of the host names explicitly described in

the server’s certificate, you have not authenticated the server’s

identity.  Any other server which was issued a certificate from

the same trusted CA can masquerade as the server unless the client

performs the host name check.</li>

</ul>

<li>Ensure that certificate verification methods/routines return no

errors.</li>

</ul>

Because only the above arguments can be passed into the Pegasus

SSLContext, there are some limitations in the client configuration:

<ul>

<li>The verification depth cannot be specified. Pegasus uses the

default OpenSSL depth of 9.</li>

<li>The cipher list cannot be specified. Pegasus uses the default

OpenSSL cipher list. The cipher lists can be found at <a

href="http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#SSL_v3_0_cipher_suites_</a>

and <a

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a>

href="http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_">http://www.openssl.org/docs/apps/ciphers.html#TLS_v1_0_cipher_suites_</a></li>

</li>

<li>No hostname checking is performed to ensure that the subject

<li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;

field of the distinguished name (DN) matches the hostname. If desired,

mso-list:l10 level1 lfo16;tab-stops:list .5in'>No hostname checking is

a user-specified callback should be configured to perform this check or

performed to ensure that the subject field of the distinguished name (DN)

any additional checks relevant to the application.</li>

matches the hostname. If desired, a user-specified callback should be

</ul>

configured to perform this check or any additional checks relevant to the

<h3><a name="AUTH">SSL Authorization</a></h3>

application.</li>

The following paragraphs concern authorization of users

</ul>

authenticated by certificate on the cimserver's HTTPS port.

<h3><a name=AUTH>SSL Authorization</a></h3>

It is important to note that SSL certificates are verified during

the initial handshake, BEFORE any further authentication takes place.

The following paragraphs concern authorization of users authenticated by

If a certificate fails, the connection can be terminated immediately,

certificate on the cimserver's HTTPS port.

resulting in a connection exception. This scenario will occur if the

sslClientVerification property is set to "required" and no certificate

It is important to note that SSL certificates are verified during the

or an untrusted certificate is sent.

initial handshake, BEFORE any further authentication takes place. If a

Further authorization checks must be performed when

certificate fails, the connection can be terminated immediately, resulting in a

validating the user that is mapped to the certificate. First, the user

connection exception. This scenario will occur if the sslClientVerification

that is registered to the certificate is validated as a valid system

property is set to "required" and no certificate or an <span

user and a valid cimuser (if the cimuser function has been configured).

class=SpellE>untrusted certificate is sent.

In the case of

a certificate chain, the username authorization starts with the leaf

Further authorization checks must be performed when validating

certificate. If it successfully finds a mapping

the user that is mapped to the certificate. First, the user that is registered

for the leaf certificate, it continues; if there is no username for the

to the certificate is validated as a valid system user and a valid <span

leaf certificate, the validation proceeds up to the root certificate.

class=SpellE>cimuser (if the cimuser function

If the root certificate is reached and there is still no mapped

has been configured). In the case of a certificate

username, the authorization fails.

chain, the username authorization starts with the leaf certificate. If it

Additionally, if Pegasus was configured to use PAM, the

successfully finds a mapping for the leaf certificate, it continues; if there

pam_acct_mgmt function will be called with the user that is mapped to

is no username for the leaf certificate, the validation proceeds up to the root

the certificate. This ensures that any login conditions that would have

certificate. If the root certificate is reached and there is still no mapped

been placed on a user authenticated via basic authentication are still

username, the authorization fails. Additionally,

applied to a user authenticated via certificate. The pam_authenticate

if Pegasus was configured to use PAM, the pam_acct_mgmt

method will NOT be called. Lastly, the providers must authorize the

function will be called with the user that is mapped to the certificate. This

user. They receive the username that was mapped to the certificate in

ensures that any login conditions that would have been placed on a user

the OperationContext.

authenticated via basic authentication are still applied to a user

<h3><a name="EXT">Critical Extension Handling</a></h3>

authenticated via certificate. The pam_authenticate

method will NOT be called. Lastly, the providers must authorize the user. They

The extensions defined for X.509 v3 certificates provide methods for

receive the username that was mapped to the certificate in the <span

associating additional attributes with users or public keys and for

class=SpellE>OperationContext.

managing the certification hierarchy. Each extension in a certificate

may be designated as critical or non-critical. Pegasus relies on the

A provider may request the client's certificate chain information through

underlying OpenSSL implementation to handle critical extensions

its provider registration MOF. The "RequestedOperationContextContainers"

specified in a certificate. Please refer to the OpenSSL documentation

property of PG_Provider should be set to include the

for more information on currently supported extensions in OpenSSL and

"SSLCertificateChain" by setting the value �0�.

on the behavior of OpenSSL in the case of unhandled critical extensions.

If a client is authenticated via trusted certificate, then the container will

include a certificate for each level in the client's certificate chain, up to a

<h3><a name="RESOURCES">Resources</a></h3>

maximum depth of seven.

For OpenSSL information pick up a copy of O'Reilly's Network Security

The behavior of this property is dependent

with OpenSSL or go to the OpenSSL Site:

on the overall CIMOM settings. The "enableHttpsConnection"

configuration property must be set to true for the property to have any effect.

Additionally, the "sslClientVerificationMode"

configuration property must be set to either "required" or

"optional". If "required" is specified, then the container

will always be populated. If "optional" is specified, the container

will be populated only if the client is authenticated via trusted certificate,

as opposed to another mechanism such as basic authentication. Because the

container may not always be included in the OperationContext,

providers should always check for its existence before performing operations on

it. See the SSLCertificateInfo class in

Pegasus/Common/SSLContext.h for a full list of

certificate parameters that the SSLCertificateChainContainer

supports. <u1:p></u1:p>

<h3><a name=EXT>Critical Extension Handling</a></h3>

The extensions defined for X.509 v3 certificates

provide methods for associating additional attributes with users or public keys

and for managing the certification hierarchy. Each extension in a certificate

may be designated as critical or non-critical. Pegasus relies on the underlying

OpenSSL implementation to handle critical extensions

specified in a certificate. Please refer to the OpenSSL

documentation for more information on currently supported extensions in <span

class=SpellE>OpenSSL and on the behavior of OpenSSL

in the case of unhandled critical extensions.

<h3><a name=RESOURCES>Resources</a></h3>

For OpenSSL information pick up a copy of

O'Reilly's Network Security with OpenSSL or go to the

OpenSSL Site:

<a href="http://www.openssl.org">http://www.openssl.org</a>

A really fabulous guide on certificate management and installation

A really fabulous guide on certificate management and installation with <span

with OpenSSL:

class=SpellE>OpenSSL:

<a href="http://www.gagravarr.org/writing/openssl-certs/index.shtml">http://www.gagravarr.org/writing/openssl-certs/index.shtml</a>

x509 Certificate and CRL RFC:

x509 Certificate and CRL RFC:

<a href="http://www.ietf.org/rfc/rfc2459.txt?number=2459">http://www.ietf.org/rfc/rfc2459.txt?number=2459</a>

SSLv3 RFC:

SSLv3 RFC:

<a href="http://wp.netscape.com/eng/ssl3/">http://wp.netscape.com/eng/ssl3</a>

<a href="http://wp.netscape.com/eng/ssl3/">http://wp.netscape.com/eng/ssl3</a>

TLSv1 RFC:

TLSv1 RFC:

Basic Authentication RFC:

Basic Authentication RFC:

<hr>

Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group;

VERITAS Software Corporation

</div>

Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group; VERITAS

Software Corporation

Permission is hereby granted, free of

Permission is hereby granted, free of charge, to any

charge, to any person obtaining a copy  of this software and associated

person obtaining a copy  of this software and associated

documentation files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use, copy, modify,

restriction, including without limitation the rights to use, copy,

merge, publish, distribute, sublicense, and/or sell copies of the Software, and

modify, merge, publish, distribute, sublicense, and/or sell copies of

to permit persons to whom the Software is furnished to do so, subject to the

the Software, and to permit persons to whom the Software is furnished

following conditions:

to do so, subject to the following conditions:

THE ABOVE COPYRIGHT NOTICE AND THIS

PERMISSION NOTICE SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE

THE SOFTWARE. THE SOFTWARE IS PROVIDED  "AS

SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE

IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

SOFTWARE. THE SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE

ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE

AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<hr>

</div>

</body>

</html>

Legend:

Removed from v.1.4.4.2
changed lines
	Added in v.1.5

No CVS admin address has been configured