- java.lang.Object
-
- javax.crypto.Mac
-
- All Implemented Interfaces:
- Cloneable
public class Mac extends Object implements Cloneable
This class provides the functionality of a "Message Authentication Code" (MAC) algorithm.A MAC provides a way to check the integrity of information transmitted over or stored in an unreliable medium, based on a secret key. Typically, message authentication codes are used between two parties that share a secret key in order to validate information transmitted between these parties.
A MAC mechanism that is based on cryptographic hash functions is referred to as HMAC. HMAC can be used with any cryptographic hash function, e.g., SHA256 or SHA384, in combination with a secret shared key. HMAC is specified in RFC 2104.
Every implementation of the Java platform is required to support the following standard
Mac
algorithms:- HmacMD5
- HmacSHA1
- HmacSHA256
- Since:
- 1.4
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
Mac(MacSpi macSpi, Provider provider, String algorithm)
Creates a MAC object.
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Returns a clone if the provider implementation is cloneable.byte[]
doFinal()
Finishes the MAC operation.byte[]
doFinal(byte[] input)
Processes the given array of bytes and finishes the MAC operation.void
doFinal(byte[] output, int outOffset)
Finishes the MAC operation.String
getAlgorithm()
Returns the algorithm name of thisMac
object.static Mac
getInstance(String algorithm)
Returns aMac
object that implements the specified MAC algorithm.static Mac
getInstance(String algorithm, Provider provider)
Returns aMac
object that implements the specified MAC algorithm.static Mac
getInstance(String algorithm, String provider)
Returns aMac
object that implements the specified MAC algorithm.int
getMacLength()
Returns the length of the MAC in bytes.Provider
getProvider()
Returns the provider of thisMac
object.void
init(Key key)
Initializes thisMac
object with the given key.void
init(Key key, AlgorithmParameterSpec params)
Initializes thisMac
object with the given key and algorithm parameters.void
reset()
Resets thisMac
object.void
update(byte input)
Processes the given byte.void
update(byte[] input)
Processes the given array of bytes.void
update(byte[] input, int offset, int len)
Processes the firstlen
bytes ininput
, starting atoffset
inclusive.void
update(ByteBuffer input)
Processesinput.remaining()
bytes in the ByteBufferinput
, starting atinput.position()
.
-
-
-
Method Detail
-
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisMac
object.This is the same name that was specified in one of the
getInstance
calls that created thisMac
object.- Returns:
- the algorithm name of this
Mac
object.
-
getInstance
public static final Mac getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aMac
object that implements the specified MAC algorithm.This method traverses the list of registered security Providers, starting with the most preferred Provider. A new Mac object encapsulating the MacSpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested MAC algorithm. See the Mac section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.- Returns:
- the new
Mac
object. - Throws:
NoSuchAlgorithmException
- if no Provider supports a MacSpi implementation for the specified algorithm.- See Also:
Provider
-
getInstance
public static final Mac getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aMac
object that implements the specified MAC algorithm.A new Mac object encapsulating the MacSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested MAC algorithm. See the Mac section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the name of the provider.- Returns:
- the new
Mac
object. - Throws:
NoSuchAlgorithmException
- if a MacSpi implementation for the specified algorithm is not available from the specified provider.NoSuchProviderException
- if the specified provider is not registered in the security provider list.IllegalArgumentException
- if theprovider
is null or empty.- See Also:
Provider
-
getInstance
public static final Mac getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aMac
object that implements the specified MAC algorithm.A new Mac object encapsulating the MacSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
- Parameters:
algorithm
- the standard name of the requested MAC algorithm. See the Mac section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.provider
- the provider.- Returns:
- the new
Mac
object. - Throws:
NoSuchAlgorithmException
- if a MacSpi implementation for the specified algorithm is not available from the specified Provider object.IllegalArgumentException
- if theprovider
is null.- See Also:
Provider
-
getProvider
public final Provider getProvider()
Returns the provider of thisMac
object.- Returns:
- the provider of this
Mac
object.
-
getMacLength
public final int getMacLength()
Returns the length of the MAC in bytes.- Returns:
- the MAC length in bytes.
-
init
public final void init(Key key) throws InvalidKeyException
Initializes thisMac
object with the given key.- Parameters:
key
- the key.- Throws:
InvalidKeyException
- if the given key is inappropriate for initializing this MAC.
-
init
public final void init(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException
Initializes thisMac
object with the given key and algorithm parameters.- Parameters:
key
- the key.params
- the algorithm parameters.- Throws:
InvalidKeyException
- if the given key is inappropriate for initializing this MAC.InvalidAlgorithmParameterException
- if the given algorithm parameters are inappropriate for this MAC.
-
update
public final void update(byte input) throws IllegalStateException
Processes the given byte.- Parameters:
input
- the input byte to be processed.- Throws:
IllegalStateException
- if thisMac
has not been initialized.
-
update
public final void update(byte[] input) throws IllegalStateException
Processes the given array of bytes.- Parameters:
input
- the array of bytes to be processed.- Throws:
IllegalStateException
- if thisMac
has not been initialized.
-
update
public final void update(byte[] input, int offset, int len) throws IllegalStateException
Processes the firstlen
bytes ininput
, starting atoffset
inclusive.- Parameters:
input
- the input buffer.offset
- the offset ininput
where the input starts.len
- the number of bytes to process.- Throws:
IllegalStateException
- if thisMac
has not been initialized.
-
update
public final void update(ByteBuffer input)
Processesinput.remaining()
bytes in the ByteBufferinput
, starting atinput.position()
. Upon return, the buffer's position will be equal to its limit; its limit will not have changed.- Parameters:
input
- the ByteBuffer- Throws:
IllegalStateException
- if thisMac
has not been initialized.- Since:
- 1.5
-
doFinal
public final byte[] doFinal() throws IllegalStateException
Finishes the MAC operation.A call to this method resets this
Mac
object to the state it was in when previously initialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
. That is, the object is reset and available to generate another MAC from the same key, if desired, via new calls toupdate
anddoFinal
. (In order to reuse thisMac
object with a different key, it must be reinitialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
.- Returns:
- the MAC result.
- Throws:
IllegalStateException
- if thisMac
has not been initialized.
-
doFinal
public final void doFinal(byte[] output, int outOffset) throws ShortBufferException, IllegalStateException
Finishes the MAC operation.A call to this method resets this
Mac
object to the state it was in when previously initialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
. That is, the object is reset and available to generate another MAC from the same key, if desired, via new calls toupdate
anddoFinal
. (In order to reuse thisMac
object with a different key, it must be reinitialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
.The MAC result is stored in
output
, starting atoutOffset
inclusive.- Parameters:
output
- the buffer where the MAC result is storedoutOffset
- the offset inoutput
where the MAC is stored- Throws:
ShortBufferException
- if the given output buffer is too small to hold the resultIllegalStateException
- if thisMac
has not been initialized.
-
doFinal
public final byte[] doFinal(byte[] input) throws IllegalStateException
Processes the given array of bytes and finishes the MAC operation.A call to this method resets this
Mac
object to the state it was in when previously initialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
. That is, the object is reset and available to generate another MAC from the same key, if desired, via new calls toupdate
anddoFinal
. (In order to reuse thisMac
object with a different key, it must be reinitialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
.- Parameters:
input
- data in bytes- Returns:
- the MAC result.
- Throws:
IllegalStateException
- if thisMac
has not been initialized.
-
reset
public final void reset()
Resets thisMac
object.A call to this method resets this
Mac
object to the state it was in when previously initialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
. That is, the object is reset and available to generate another MAC from the same key, if desired, via new calls toupdate
anddoFinal
. (In order to reuse thisMac
object with a different key, it must be reinitialized via a call toinit(Key)
orinit(Key, AlgorithmParameterSpec)
.
-
clone
public final Object clone() throws CloneNotSupportedException
Returns a clone if the provider implementation is cloneable.- Overrides:
clone
in classObject
- Returns:
- a clone if the provider implementation is cloneable.
- Throws:
CloneNotSupportedException
- if this is called on a delegate that does not supportCloneable
.- See Also:
Cloneable
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/crypto/mac.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.