starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-02-04 13:34:59 +00:00
Code Issues 975 Packages Projects Releases 20 Wiki Activity

Rar.UnpackV1.Unpack.window is being used without initialized even when archive is solid #554

New Issue
Open
opened 2026-01-29 22:13:41 +00:00 by claunia · 1 comment
claunia commented 2026-01-29 22:13:41 +00:00
Owner
Copy Link

Originally created by @RigoLigoRLC on GitHub (Dec 17, 2022).

I'm a contributor to OpenUtau (a SharpCompress user open source software) and was debugging an issue where some RAR archives can crash the app.

Application code from OpenUtau (that is crashing):

            using (var archive = ArchiveFactory.Open(ArchiveFilePath, readerOptions)) {
                textItems.Clear();
                foreach (var entry in archive.Entries.Where(entry => entry.Key.EndsWith("character.txt") || entry.Key.EndsWith("oto.ini"))) {
                    using (var stream = entry.OpenEntryStream()) { // Crashes here
                        using var reader = new StreamReader(stream, TextEncoding);
                        textItems.Add($"------ {entry.Key} ------");
                        int count = 0;
                        while (count < 256 && !reader.EndOfStream) {
                            string? line = reader.ReadLine();
                            if (!string.IsNullOrWhiteSpace(line)) {
                                textItems.Add(line);
                                count++;
                            }
                        }
                        if (!reader.EndOfStream) {
                            textItems.Add($"...");
                        }
                    }
                }
            }

With help of dnSpy I can trace it down and single step to find this statement that causes an exception in Rar.UnpackV1.Unpack.Unpack29:
图片

I know nothing about SharpCompress' internals and how RAR decompressing works but basically the code tells me that if the archive is solid then the window member is not initialized:

            if (!fileHeader.IsSolid)
            {
                Init(null);
            }

Now that this archive apparently violated this rule.

Stack trace (from OpenUtau):

at SharpCompress.Compressors.Rar.UnpackV1.Unpack.Unpack29(Boolean solid)
   at SharpCompress.Compressors.Rar.UnpackV1.Unpack.DoUnpack()
   at SharpCompress.Compressors.Rar.UnpackV1.Unpack.DoUnpack(FileHeader fileHeader, Stream readStream, Stream writeStream)
   at SharpCompress.Compressors.Rar.RarStream..ctor(IRarUnpack unpack, FileHeader fileHeader, Stream readStream)
   at SharpCompress.Archives.Rar.RarArchiveEntry.OpenEntryStream()
   at OpenUtau.App.ViewModels.SingerSetupViewModel.RefreshTextItems() in D:\contrib\OpenUtau\OpenUtau\ViewModels\SingerSetupViewModel.cs:line 143
   at OpenUtau.App.ViewModels.SingerSetupViewModel.<.ctor>b__42_8(ValueTuple`2 _) in D:\contrib\OpenUtau\OpenUtau\ViewModels\SingerSetupViewModel.cs:line 91
...

Archive causing the failure: Mediafire

Originally created by @RigoLigoRLC on GitHub (Dec 17, 2022). I'm a contributor to OpenUtau (a SharpCompress user open source software) and was debugging an issue where some RAR archives can crash the app. Application code from OpenUtau (that is crashing): ```csharp using (var archive = ArchiveFactory.Open(ArchiveFilePath, readerOptions)) { textItems.Clear(); foreach (var entry in archive.Entries.Where(entry => entry.Key.EndsWith("character.txt") || entry.Key.EndsWith("oto.ini"))) { using (var stream = entry.OpenEntryStream()) { // Crashes here using var reader = new StreamReader(stream, TextEncoding); textItems.Add($"------ {entry.Key} ------"); int count = 0; while (count < 256 && !reader.EndOfStream) { string? line = reader.ReadLine(); if (!string.IsNullOrWhiteSpace(line)) { textItems.Add(line); count++; } } if (!reader.EndOfStream) { textItems.Add($"..."); } } } } ``` With help of dnSpy I can trace it down and single step to find this statement that causes an exception in `Rar.UnpackV1.Unpack.Unpack29`: ![图片](https://user-images.githubusercontent.com/49363666/208238781-137119bb-f072-43a0-b03f-d0df26d1417d.png) I know nothing about SharpCompress' internals and how RAR decompressing works but basically the code tells me that if the archive is solid then the [`window` member is not initialized](https://github.com/adamhathcock/sharpcompress/blob/cfef228afc7ca390f449efbca9de9d7d8db81182/src/SharpCompress/Compressors/Rar/UnpackV1/Unpack.cs#L110): ```csharp if (!fileHeader.IsSolid) { Init(null); } ``` Now that this archive apparently violated this rule. Stack trace (from OpenUtau): ``` at SharpCompress.Compressors.Rar.UnpackV1.Unpack.Unpack29(Boolean solid) at SharpCompress.Compressors.Rar.UnpackV1.Unpack.DoUnpack() at SharpCompress.Compressors.Rar.UnpackV1.Unpack.DoUnpack(FileHeader fileHeader, Stream readStream, Stream writeStream) at SharpCompress.Compressors.Rar.RarStream..ctor(IRarUnpack unpack, FileHeader fileHeader, Stream readStream) at SharpCompress.Archives.Rar.RarArchiveEntry.OpenEntryStream() at OpenUtau.App.ViewModels.SingerSetupViewModel.RefreshTextItems() in D:\contrib\OpenUtau\OpenUtau\ViewModels\SingerSetupViewModel.cs:line 143 at OpenUtau.App.ViewModels.SingerSetupViewModel.<.ctor>b__42_8(ValueTuple`2 _) in D:\contrib\OpenUtau\OpenUtau\ViewModels\SingerSetupViewModel.cs:line 91 ... ``` Archive causing the failure: [Mediafire](https://www.mediafire.com/download/vzxn8sxvzkgtfn3/Kuuki_Aether_chinesevcv_1.0.rar)
claunia commented 2026-01-29 22:13:41 +00:00
Author
Owner
Copy Link

@adamhathcock commented on GitHub (Dec 20, 2022):

The issue here is that this is a SOLID archive.

In RAR, you cannot randomly access a SOLID archive like a normal archive. Therefore, you should use the RarReader/ReaderFactory interface and treat it as a forward-only stream.

https://documentation.help/WinRAR/HELPArcSolid.htm

This detection is RAR specific and isn't available in the generic usage. I probably should have a more specific exception instead of having that random null exception

@adamhathcock commented on GitHub (Dec 20, 2022): The issue here is that this is a SOLID archive. In RAR, you cannot randomly access a SOLID archive like a normal archive. Therefore, you should use the RarReader/ReaderFactory interface and treat it as a forward-only stream. https://documentation.help/WinRAR/HELPArcSolid.htm This detection is RAR specific and isn't available in the generic usage. I probably should have a more specific exception instead of having that random null exception
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
duplicate
enhancement
feedback requested
not bug
pull-request
Mirrored from GitHub Pull Request
 question
up for grabs
wontfix
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/sharpcompress#554
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?