< Summary

Information
Class: System.IO.Compression.WinZipAesKeyMaterial
Assembly: System.IO.Compression
File(s): D:\runner\runtime\src\libraries\System.IO.Compression\src\System\IO\Compression\WinZipAesKeyMaterial.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 56
Coverable lines: 56
Total lines: 99
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 8
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Cyclomatic complexity NPath complexity Sequence coverage
.ctor(...)0%220%
Create(...)0%660%
GetSaltSize(...)100%110%

File(s)

D:\runner\runtime\src\libraries\System.IO.Compression\src\System\IO\Compression\WinZipAesKeyMaterial.cs

#LineLine coverage
 1// Licensed to the .NET Foundation under one or more agreements.
 2// The .NET Foundation licenses this file to you under the MIT license.
 3
 4using System.Buffers;
 5using System.Diagnostics;
 6using System.Runtime.Versioning;
 7using System.Security.Cryptography;
 8using System.Text;
 9
 10namespace System.IO.Compression
 11{
 12    /// <summary>
 13    /// Represents the parsed components of WinZip AES key material.
 14    /// The key material layout is: [salt][encryption key][HMAC key][password verifier (2 bytes)].
 15    /// </summary>
 16    internal readonly struct WinZipAesKeyMaterial
 17    {
 018        public byte[] Salt { get; }
 019        public byte[] EncryptionKey { get; }
 020        public byte[] HmacKey { get; }
 021        public byte[] PasswordVerifier { get; }
 22        public int KeySizeBits { get; }
 023        public int SaltSize { get; }
 24
 25        private WinZipAesKeyMaterial(byte[] salt, byte[] encryptionKey, byte[] hmacKey, byte[] passwordVerifier, int key
 026        {
 027            if (OperatingSystem.IsBrowser())
 028            {
 029                throw new PlatformNotSupportedException(SR.WinZipEncryptionNotSupportedOnBrowser);
 30            }
 031            Salt = salt;
 032            EncryptionKey = encryptionKey;
 033            HmacKey = hmacKey;
 034            PasswordVerifier = passwordVerifier;
 035            KeySizeBits = keySizeBits;
 036            SaltSize = GetSaltSize(keySizeBits);
 037        }
 38
 39        /// <summary>
 40        /// Derives key material from a password and optional salt using PBKDF2-SHA1.
 41        /// </summary>
 42        internal static unsafe WinZipAesKeyMaterial Create(ReadOnlySpan<char> password, byte[]? salt, int keySizeBits)
 043        {
 044            if (OperatingSystem.IsBrowser())
 045            {
 046                throw new PlatformNotSupportedException(SR.WinZipEncryptionNotSupportedOnBrowser);
 47            }
 048            int saltSize = GetSaltSize(keySizeBits);
 049            int keySizeBytes = keySizeBits / 8;
 050            int totalKeySize = checked(keySizeBytes + keySizeBytes + 2);
 51
 52            byte[] saltBytes;
 053            if (salt is null)
 054            {
 055                saltBytes = new byte[saltSize];
 056                RandomNumberGenerator.Fill(saltBytes);
 057            }
 58            else
 059            {
 060                Debug.Assert(salt.Length == saltSize, $"Salt must be {saltSize} bytes for AES-{keySizeBits}.");
 061                saltBytes = salt;
 062            }
 63
 064            int maxPasswordByteCount = Encoding.UTF8.GetMaxByteCount(password.Length);
 065            byte[] rentedPasswordBytes = ArrayPool<byte>.Shared.Rent(maxPasswordByteCount);
 066            Debug.Assert(totalKeySize <= 66, "totalKeySize should be at most 66 bytes (AES-256: 32 + 32 + 2)");
 067            Span<byte> derivedKey = stackalloc byte[totalKeySize];
 68
 69            try
 070            {
 071                int actualByteCount = Encoding.UTF8.GetBytes(password, rentedPasswordBytes);
 072                Span<byte> passwordSpan = rentedPasswordBytes.AsSpan(0, actualByteCount);
 73
 074                Rfc2898DeriveBytes.Pbkdf2(
 075                    passwordSpan,
 076                    saltBytes,
 077                    derivedKey,
 078                    1000, // iteration count specified by the WinZip AE-1/AE-2 specification
 079                    HashAlgorithmName.SHA1);
 80
 81                // Slice the derived key directly into its components instead of
 82                // round-tripping through a combined array and Parse.
 083                byte[] encryptionKey = derivedKey.Slice(0, keySizeBytes).ToArray();
 084                byte[] hmacKey = derivedKey.Slice(keySizeBytes, keySizeBytes).ToArray();
 085                byte[] passwordVerifier = derivedKey.Slice(keySizeBytes + keySizeBytes, 2).ToArray();
 86
 087                return new WinZipAesKeyMaterial(saltBytes, encryptionKey, hmacKey, passwordVerifier, keySizeBits);
 88            }
 89            finally
 090            {
 091                CryptographicOperations.ZeroMemory(rentedPasswordBytes);
 092                CryptographicOperations.ZeroMemory(derivedKey);
 093                ArrayPool<byte>.Shared.Return(rentedPasswordBytes);
 094            }
 095        }
 96
 097        internal static int GetSaltSize(int keySizeBits) => keySizeBits / 16;
 98    }
 99}