1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_auth_SSOManagerFactory_idl__
29#define __com_sun_star_auth_SSOManagerFactory_idl__
30
31#ifndef __com_sun_star_auth_XSSOManagerFactory_idl_
32#include <com/sun/star/auth/XSSOManagerFactory.idl>
33#endif
34
35module com { module sun { module star { module auth {
36
37/** represents a starting point for Single Signon interactions.
38    <P>The Single Signon ( SSO ) apis provide UNO based access to underlying
39	   SSO implementations ( e.g. Kerberos ). The aim of the SSO apis is to
40       enable authentication ( possibly mutual ) between a client ( source or
41       initiator ) and a network service ( target or acceptor ). This is
42       achieved via. the creation and processing of security tokens sent
43       between the two parties. The steps which should be followed to
44	   successfully use the SSO apis are as follows:
45    <UL>
46        <LI>Create an <type>XSSOManagerFactory</type> instance</LI>
47        <LI>Use this factory to create/retrieve an <type>XSSOManager</type>
48            instance.</LI>
49        <LI>Depending on whether your code is acting as SSO source or target,
50            you should use the <type>XSSOManager</type> instance to create an
51            initiator security context, <type>XSSOInitiatorContext</type> or an
52            acceptor security context, <type>XSSOAcceptorContext</type>
53            respectively.</LI>
54		<LI>On the initiator side, use the previously created context to process
55            security tokens received from the acceptor side and to create
56            security tokens to send to the acceptor side. On the acceptor side,
57            use the previously created context to process security tokens
58            received from the initiator side and to create security tokens to
59            send to the initiator side.</LI>
60    </UL>
61
62    @since OOo 1.1.2
63 */
64
65published service SSOManagerFactory
66{
67   /** supports the creation of <type>XSSOManager</type> instances which can
68       subsequently be used to create security contexts.
69    */
70	interface XSSOManagerFactory;
71};
72
73}; }; }; };
74
75#endif
76