01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.crypto.digest;
23:
24: import java.util.Map;
25: import java.security.MessageDigest;
26:
27: /**
28: * An interface that can be used to augment the behavior of a digest hash.
29: * One example usecase is with the password based login modules to
30: * modify the behavior of the hashing to introduce prefix/suffix salts.
31: *
32: * @author Scott.Stark@jboss.org
33: * @version $Revision: 57203 $
34: */
35: public interface DigestCallback {
36: /** Pass through access to the login module options. When coming from a
37: * login module this includes the following keys:
38: * javax.security.auth.login.name - for the username
39: * javax.security.auth.login.password - for the String password
40: */
41: public void init(Map options);
42:
43: /**
44: * Pre-hash callout to allow for content before the password. Any content
45: * should be added using the MessageDigest update methods.
46: * @param digest - the security digest being used for the one-way hash
47: */
48: public void preDigest(MessageDigest digest);
49:
50: /** Post-hash callout afer the password has been added to allow for content
51: * after the password has been added. Any content should be added using the
52: * MessageDigest update methods.
53: * @param digest - the security digest being used for the one-way hash
54: */
55: public void postDigest(MessageDigest digest);
56: }
|