01: /*
02: * Copyright (c) 2007, intarsys consulting GmbH
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * - Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * - Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * - Neither the name of intarsys nor the names of its contributors may be used
15: * to endorse or promote products derived from this software without specific
16: * prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28: * POSSIBILITY OF SUCH DAMAGE.
29: */
30: package de.intarsys.pdf.crypt;
31:
32: import de.intarsys.pdf.st.STDocument;
33: import de.intarsys.tools.authenticate.IPasswordProvider;
34:
35: /**
36: * The security handler as defined in the PDF spec. This is the exchangeable
37: * behavior in the PDF security spec.
38: * <p>
39: * The {@link ISystemSecurityHandler} is asked for de/encryption, which is done
40: * by himself for the defined standard encryptions, using {@link ICryptHandler}
41: * instances for RC4 and AES. These {@link ICryptHandler} instances are
42: * initialized using the encryption key provided by this
43: * {@link ISecurityHandler}.
44: * <p>
45: * With /V 4 encryption, thhe application may ask for "transparent"
46: * de/encryption, in which case it is forwared to the installed
47: * {@link ISecurityHandler} itself.
48: *
49: */
50: public interface ISecurityHandler extends ICryptHandler {
51:
52: /**
53: * Perform an authentication of the current "user" on behalf of the
54: * information in the encryption dictionary.
55: * <p>
56: * In most situations this will consist of checking user/owner password and
57: * setting the resulting access permissions.
58: *
59: * @throws COSSecurityException
60: */
61: public void authenticate(IPasswordProvider passwordProvider)
62: throws COSSecurityException;
63:
64: public byte[] getCryptKey();
65:
66: public void init(STDocument document, COSEncryption encryption)
67: throws COSSecurityException;
68:
69: /**
70: * The access permissions encoded in the encryption object for the current
71: * document or null if not applicable.
72: * <p>
73: * The access permissions are not standardized, may be these are not
74: * available from arbitrary handlers.
75: *
76: * @return The access permissions encoded in the encryption object for the
77: * current document or null if not applicable.
78: */
79: public IAccessPermissions getAccessPermissions();
80:
81: }
|