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 module com { module sun { module star { module auth {
  21
  22 /** represents a starting point for Single Sign-on interactions.
  23     <P>The Single Sign-on ( SSO ) APIs provide UNO based access to underlying
  24        SSO implementations ( e.g. Kerberos ). The aim of the SSO APIs is to
  25        enable authentication ( possibly mutual ) between a client ( source or
  26        initiator ) and a network service ( target or acceptor ). This is
  27        achieved via. the creation and processing of security tokens sent
  28        between the two parties. The steps which should be followed to
  29        successfully use the SSO APIs are as follows:
  30     <UL>
  31         <LI>Create an XSSOManagerFactory instance</LI>
  32         <LI>Use this factory to create/retrieve an XSSOManager
  33             instance.</LI>
  34         <LI>Depending on whether your code is acting as SSO source or target,
  35             you should use the XSSOManager instance to create an
  36             initiator security context, XSSOInitiatorContext or an
  37             acceptor security context, XSSOAcceptorContext
  38             respectively.</LI>
  39         <LI>On the initiator side, use the previously created context to process
  40             security tokens received from the acceptor side and to create
  41             security tokens to send to the acceptor side. On the acceptor side,
  42             use the previously created context to process security tokens
  43             received from the initiator side and to create security tokens to
  44             send to the initiator side.</LI>
  45     </UL>
  46
  47     The interface supports the creation of XSSOManager instances
  48     which can subsequently be used to create security contexts.
  49
  50     @since OOo 1.1.2
  51  */
  52
  53 published service SSOManagerFactory: XSSOManagerFactory;
  54
  55 }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */