a0a60e0460d3966d3f62d779f6a7bae18f95b6dc
[WebKit-https.git] / Source / WebCore / crypto / keys / CryptoKeyHMAC.h
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef CryptoKeyHMAC_h
27 #define CryptoKeyHMAC_h
28
29 #include "CryptoKey.h"
30 #include <wtf/Vector.h>
31
32 #if ENABLE(SUBTLE_CRYPTO)
33
34 namespace WebCore {
35
36 class CryptoKeyHMAC FINAL : public CryptoKey {
37 public:
38     static PassRefPtr<CryptoKeyHMAC> create(const Vector<char>& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsage usage)
39     {
40         return adoptRef(new CryptoKeyHMAC(key, hash, extractable, usage));
41     }
42     virtual ~CryptoKeyHMAC();
43
44     // If lengthBytes is 0, a recommended length is used, which is the size of the associated hash function's block size.
45     static PassRefPtr<CryptoKeyHMAC> generate(size_t lengthBytes, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsage);
46
47     virtual CryptoKeyClass keyClass() const OVERRIDE { return CryptoKeyClass::HMAC; }
48
49     const Vector<char>& key() const { return m_key; }
50
51     virtual void buildAlgorithmDescription(CryptoAlgorithmDescriptionBuilder&) const OVERRIDE;
52
53 private:
54     CryptoKeyHMAC(const Vector<char>& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsage);
55
56     CryptoAlgorithmIdentifier m_hash;
57     Vector<char> m_key;
58 };
59
60 inline bool isCryptoKeyHMAC(const CryptoKey& key)
61 {
62     return key.keyClass() == CryptoKeyClass::HMAC;
63 }
64
65 inline const CryptoKeyHMAC& toCryptoKeyHMAC(const CryptoKey& key)
66 {
67     ASSERT_WITH_SECURITY_IMPLICATION(isCryptoKeyHMAC(key));
68     return static_cast<const CryptoKeyHMAC&>(key);
69 }
70
71 inline CryptoKeyHMAC& toCryptoKeyHMAC(CryptoKey& key)
72 {
73     ASSERT_WITH_SECURITY_IMPLICATION(isCryptoKeyHMAC(key));
74     return static_cast<CryptoKeyHMAC&>(key);
75 }
76
77 } // namespace WebCore
78
79 #endif // ENABLE(SUBTLE_CRYPTO)
80 #endif // CryptoKeyHMAC_h