1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_auth_SSOManagerFactory_idl__
25#define __com_sun_star_auth_SSOManagerFactory_idl__
26
27#ifndef __com_sun_star_auth_XSSOManagerFactory_idl_
28#include <com/sun/star/auth/XSSOManagerFactory.idl>
29#endif
30
31module com { module sun { module star { module auth {
32
33/** represents a starting point for Single Signon interactions.
34    <P>The Single Signon ( SSO ) apis provide UNO based access to underlying
35	   SSO implementations ( e.g. Kerberos ). The aim of the SSO apis is to
36       enable authentication ( possibly mutual ) between a client ( source or
37       initiator ) and a network service ( target or acceptor ). This is
38       achieved via. the creation and processing of security tokens sent
39       between the two parties. The steps which should be followed to
40	   successfully use the SSO apis are as follows:
41    <UL>
42        <LI>Create an <type>XSSOManagerFactory</type> instance</LI>
43        <LI>Use this factory to create/retrieve an <type>XSSOManager</type>
44            instance.</LI>
45        <LI>Depending on whether your code is acting as SSO source or target,
46            you should use the <type>XSSOManager</type> instance to create an
47            initiator security context, <type>XSSOInitiatorContext</type> or an
48            acceptor security context, <type>XSSOAcceptorContext</type>
49            respectively.</LI>
50		<LI>On the initiator side, use the previously created context to process
51            security tokens received from the acceptor side and to create
52            security tokens to send to the acceptor side. On the acceptor side,
53            use the previously created context to process security tokens
54            received from the initiator side and to create security tokens to
55            send to the initiator side.</LI>
56    </UL>
57
58    @since OpenOffice 1.1.2
59 */
60
61published service SSOManagerFactory
62{
63   /** supports the creation of <type>XSSOManager</type> instances which can
64       subsequently be used to create security contexts.
65    */
66	interface XSSOManagerFactory;
67};
68
69}; }; }; };
70
71#endif
72