1 /*
2 * MIT License
3 *
4 * Copyright (c) 2010-2024 The Waffle Project Contributors: https://github.com/Waffle/waffle/graphs/contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24 package waffle.windows.auth;
25
26 import com.sun.jna.platform.win32.Sspi;
27 import com.sun.jna.platform.win32.Sspi.CtxtHandle;
28 import com.sun.jna.platform.win32.Sspi.SecBufferDesc;
29
30 /**
31 * A Windows security context.
32 */
33 public interface IWindowsSecurityContext {
34
35 /**
36 * Security package name.
37 *
38 * @return String.
39 */
40 String getSecurityPackage();
41
42 /**
43 * Principal name.
44 *
45 * @return String.
46 */
47 String getPrincipalName();
48
49 /**
50 * Token.
51 *
52 * @return Array of bytes.
53 */
54 byte[] getToken();
55
56 /**
57 * True if protocol requires continuation.
58 *
59 * @return True or false.
60 */
61 boolean isContinue();
62
63 /**
64 * Windows Identity.
65 *
66 * @return Windows Identity.
67 */
68 IWindowsIdentity getIdentity();
69
70 /**
71 * Context handle.
72 *
73 * @return Handle.
74 */
75 Sspi.CtxtHandle getHandle();
76
77 /**
78 * Initialize the security context, continuing from a previous one.
79 *
80 * @param continueCtx
81 * Continue context.
82 * @param continueToken
83 * Continue token.
84 * @param targetName
85 * The target of the context. The string contents are security-package specific.
86 */
87 void initialize(final CtxtHandle continueCtx, final SecBufferDesc continueToken, final String targetName);
88
89 /**
90 * Impersonate this security context.
91 *
92 * @return A Windows Impersonation Context.
93 */
94 IWindowsImpersonationContext impersonate();
95
96 /**
97 * Disposes of the context.
98 */
99 void dispose();
100 }