xref: /freebsd/crypto/krb5/src/ccapi/server/win/ccs_win_pipe.h (revision b670c9bafc0e31c7609969bf374b2e80bdc00211)
1 /* ccapi/server/win/ccs_win_pipe.h */
2 /*
3  * Copyright 2008 Massachusetts Institute of Technology.
4  * All Rights Reserved.
5  *
6  * Export of this software from the United States of America may
7  * require a specific license from the United States Government.
8  * It is the responsibility of any person or organization contemplating
9  * export to obtain such a license before exporting.
10  *
11  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
12  * distribute this software and its documentation for any purpose and
13  * without fee is hereby granted, provided that the above copyright
14  * notice appear in all copies and that both that copyright notice and
15  * this permission notice appear in supporting documentation, and that
16  * the name of M.I.T. not be used in advertising or publicity pertaining
17  * to distribution of the software without specific, written prior
18  * permission.  Furthermore if you modify this software you must label
19  * your software as modified software and not distribute it in such a
20  * fashion that it might be confused with the original M.I.T. software.
21  * M.I.T. makes no representations about the suitability of
22  * this software for any purpose.  It is provided "as is" without express
23  * or implied warranty.
24  */
25 
26 #ifndef _ccs_win_pipe_h_
27 #define _ccs_win_pipe_h_
28 
29 #include "windows.h"
30 
31 #include "CredentialsCache.h"
32 
33 /* ------------------------------------------------------------------------ */
34 
35 /* On Windows, a pipe is a struct containing a UUID and a handle.  Both the
36    UUID and handle are supplied by the client.
37 
38    The UUID is used to build the client's reply endpoint.
39 
40    The handle is to the requesting client thread's thread local storage struct,
41    so that the client's one and only reply handler can put reply data where
42    the requesting thread will be able to see it.
43  */
44 
45 struct ccs_win_pipe_t {
46     char*   uuid;
47     UINT64  clientHandle;
48     };
49 
50 typedef struct ccs_win_pipe_t WIN_PIPE;
51 
52 struct ccs_win_pipe_t*  ccs_win_pipe_new(const char* uuid, const UINT64 h);
53 
54 cc_int32    ccs_win_pipe_release    (const WIN_PIPE* io_pipe);
55 
56 cc_int32    ccs_win_pipe_compare    (const WIN_PIPE* win_pipe_1,
57                                      const WIN_PIPE* win_pipe_2,
58                                      cc_uint32  *out_equal);
59 
60 cc_int32    ccs_win_pipe_copy       (WIN_PIPE** out_pipe,
61                                      const WIN_PIPE* in_pipe);
62 
63 cc_int32    ccs_win_pipe_valid      (const WIN_PIPE* in_pipe);
64 
65 char*       ccs_win_pipe_getUuid    (const WIN_PIPE* in_pipe);
66 UINT64      ccs_win_pipe_getHandle  (const WIN_PIPE* in_pipe);
67 
68 #endif // _ccs_win_pipe_h_
69