dcmnet/include/dcmtk/dcmnet/dcuserid.h

/*
 *
 *  Copyright (C) 2008-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 * Author: Michael Onken
 *
 * Module: dcmnet
 *
 * Purpose:
 *   User Identity Negotiation for A-ASSOCIATE (Supp. 99)
 *
 * Last Update:         $Author: joergr $
 * Update Date:         $Date: 2010-10-14 13:17:22 $
 * CVS/RCS Revision:    $Revision: 1.7 $
 * Status:              $State: Exp $
 *
 * CVS/RCS Log at end of file
 *
 */

#ifndef DCUSERID_H
#define DCUSERID_H

#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/ofstd/ofcond.h"

#define DUL_TYPENEGOTIATIONOFUSERIDENTITY (unsigned char)0x58

enum T_ASC_UserIdentityNegotiationMode
{
    ASC_USER_IDENTITY_NONE            = 0,
    ASC_USER_IDENTITY_USER            = 1,
    ASC_USER_IDENTITY_USER_PASSWORD   = 2,
    ASC_USER_IDENTITY_KERBEROS        = 3,
    ASC_USER_IDENTITY_SAML            = 4,
    ASC_USER_IDENTITY_UNKNOWN
};


class UserIdentityNegotiationSubItem {

public:

  UserIdentityNegotiationSubItem();

  virtual unsigned char pduType() const =0;

  virtual unsigned char getItemType() const {return m_itemType;}

  virtual unsigned char getReserved() const {return m_reserved;}

  virtual OFCondition streamedLength(unsigned long& length) const = 0;

  virtual OFCondition parseFromBuffer(unsigned char *readBuffer,
                                      unsigned long& bytesRead,
                                      unsigned long availData) =0;

  virtual OFCondition stream(unsigned char *targetBuffer,
                             unsigned long& lengthWritten) const =0;

  virtual void clear() =0;

  virtual void dump(STD_NAMESPACE ostream& outstream) const =0;

  virtual ~UserIdentityNegotiationSubItem() {}

private:

  const unsigned char m_itemType;

  const unsigned char m_reserved;

};


class UserIdentityNegotiationSubItemRQ : public UserIdentityNegotiationSubItem {

public:

  UserIdentityNegotiationSubItemRQ();

  unsigned char pduType() const;

  virtual void clear();

  void setIdentityType(const T_ASC_UserIdentityNegotiationMode& mode);

   T_ASC_UserIdentityNegotiationMode getIdentityType();

  void setPrimField(const char *buffer,
                    const Uint16& length);

  void setSecField(const char *buffer,
                   const Uint16& length);

  Uint16 getPrimField(char*& resultBuf,
                      Uint16& resultLen) const;

  Uint16 getSecField(char*& resultBuf,
                     Uint16& resultLen) const;

  void setReqPosResponse(const OFBool& reqPosRsp);


  OFBool isPosResponseRequested()
  {
     return (m_posRspRequested != 0) ? OFTrue: OFFalse;
  }

  OFCondition stream(unsigned char *targetBuffer,
                     unsigned long& lengthWritten) const;

  OFCondition streamedLength(unsigned long& length) const;

  OFCondition parseFromBuffer(unsigned char *readBuffer,
                              unsigned long &bytesRead,
                              unsigned long availData);

  void dump(STD_NAMESPACE ostream& outstream) const;

  UserIdentityNegotiationSubItemRQ& operator= (const UserIdentityNegotiationSubItemRQ& rhs);

  UserIdentityNegotiationSubItemRQ(const UserIdentityNegotiationSubItemRQ& rhs);

  ~UserIdentityNegotiationSubItemRQ();

private:

  T_ASC_UserIdentityNegotiationMode m_userIdentityType;
  unsigned char m_posRspRequested;
  char* m_primField;
  Uint16 m_primFieldLength;
  char* m_secField;
  Uint16 m_secFieldLength;
};


class UserIdentityNegotiationSubItemAC : public UserIdentityNegotiationSubItem {

public:

  UserIdentityNegotiationSubItemAC();

  unsigned char pduType() const;

  virtual void clear();

  void setServerResponse(const char* rsp,
                         const Uint16& rspLen);

  Uint16 getServerResponse(char*& targetBuffer,
                           Uint16& resultLen) const;

  OFCondition streamedLength(unsigned long& length) const;

  OFCondition stream(unsigned char *targetBuffer,
                     unsigned long& lengthWritten) const;

  OFCondition parseFromBuffer(unsigned char *readBuffer,
                              unsigned long &bytesRead,
                              unsigned long availData);

  void dump(STD_NAMESPACE ostream& outstream) const;

  UserIdentityNegotiationSubItemAC& operator= (const UserIdentityNegotiationSubItemAC& rhs);

  UserIdentityNegotiationSubItemAC(const UserIdentityNegotiationSubItemAC& rhs);

  ~UserIdentityNegotiationSubItemAC();

private:

  char* m_serverRsp;
  Uint16 m_rspLength;

};

#endif // DCUSERID_H

/*
** CVS/RCS Log:
** $Log: dcuserid.h,v $
** Revision 1.7  2010-10-14 13:17:22  joergr
** Updated copyright header. Added reference to COPYRIGHT file.
**
** Revision 1.6  2010-10-05 11:01:04  uli
** Removed a unused copy-constructor and a unused operator=.
**
** Revision 1.5  2010-09-14 11:42:14  uli
** Verify the length fields in the PDUs that we receive.
**
** Revision 1.4  2009-09-29 14:34:16  uli
** Include only the needed headers in dcuserid.h and not dctk.h.
**
** Revision 1.3  2008-10-07 09:08:13  onken
** Fixed possible memory leak in user identity classes and added code for
** accessing user identity from the server's side. Thanks to "Pim"
**
** Revision 1.2  2008-04-17 16:09:32  onken
** Added some const definitions to functions.
**
** Revision 1.1  2008-04-17 15:28:33  onken
** Reworked and extended User Identity Negotiation code.
**
*/

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1