offapi/com/sun/star/auth/XSSOAcceptorContext.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_XSSOAcceptorContext_idl__
  21 #define __com_sun_star_auth_XSSOAcceptorContext_idl__
  22
  23 #include <com/sun/star/auth/AuthenticationFailedException.idl>
  24 #include <com/sun/star/auth/InvalidArgumentException.idl>
  25 #include <com/sun/star/auth/InvalidContextException.idl>
  26 #include <com/sun/star/auth/InvalidCredentialException.idl>
  27 #include <com/sun/star/auth/XSSOContext.idl>
  28
  29 module com { module sun { module star { module auth {
  30
  31 /** represents an acceptor side security context.
  32     <P>This context may be used to authenticate a Single Sign-on initiator based
  33        on a security token sent by the initiator and to generate a token to be
  34        sent back to the initiator so that it can authenticate the acceptor.
  35
  36     @since OOo 1.1.2
  37 */
  38
  39 published interface XSSOAcceptorContext : ::com::sun::star::auth::XSSOContext
  40 {
  41     /** accepts/authenticates an SSO token sent from the context initiator side.
  42         <P>
  43         accept() should be called only once. Subsequent calls produce
  44         undefined results.
  45
  46         @param Token
  47         the SSO token sent by the initiator.
  48
  49         @returns
  50         the sequence of bytes to be sent back to the initiator to allow
  51         authentication of the acceptor side, if mutual authentication is
  52         supported by the security context. If mutual authentication is not
  53         supported a zero length sequence is returned.
  54      */
  55
  56     sequence< byte >    accept( [in] sequence< byte > Token )
  57         raises( InvalidArgumentException,
  58                 InvalidCredentialException,
  59                 InvalidContextException,
  60                 AuthenticationFailedException );
  61 };
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */