offapi/com/sun/star/auth/SSOManagerFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_auth_SSOManagerFactory_idl__
  21 #define __com_sun_star_auth_SSOManagerFactory_idl__
  22
  23 #include <com/sun/star/auth/XSSOManagerFactory.idl>
  24
  25 module com { module sun { module star { module auth {
  26
  27 /** represents a starting point for Single Sign-on interactions.
  28     <P>The Single Sign-on ( SSO ) APIs provide UNO based access to underlying
  29        SSO implementations ( e.g. Kerberos ). The aim of the SSO APIs is to
  30        enable authentication ( possibly mutual ) between a client ( source or
  31        initiator ) and a network service ( target or acceptor ). This is
  32        achieved via. the creation and processing of security tokens sent
  33        between the two parties. The steps which should be followed to
  34        successfully use the SSO APIs are as follows:
  35     <UL>
  36         <LI>Create an XSSOManagerFactory instance</LI>
  37         <LI>Use this factory to create/retrieve an XSSOManager
  38             instance.</LI>
  39         <LI>Depending on whether your code is acting as SSO source or target,
  40             you should use the XSSOManager instance to create an
  41             initiator security context, XSSOInitiatorContext or an
  42             acceptor security context, XSSOAcceptorContext
  43             respectively.</LI>
  44         <LI>On the initiator side, use the previously created context to process
  45             security tokens received from the acceptor side and to create
  46             security tokens to send to the acceptor side. On the acceptor side,
  47             use the previously created context to process security tokens
  48             received from the initiator side and to create security tokens to
  49             send to the initiator side.</LI>
  50     </UL>
  51
  52     The interface supports the creation of XSSOManager instances
  53     which can subsequently be used to create security contexts.
  54
  55     @since OOo 1.1.2
  56  */
  57
  58 published service SSOManagerFactory: XSSOManagerFactory;
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */