GARbro-mirror/ArcFormats/Entis/ArcNOA.cs

556 lines
19 KiB
C#
Raw Normal View History

2015-05-27 17:57:34 +08:00
//! \file ArcNOA.cs
//! \date Thu Apr 23 15:57:17 2015
//! \brief Entis GLS engine archives implementation.
//
// Copyright (C) 2015 by morkt
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
2015-05-27 17:57:34 +08:00
using System.Diagnostics;
using System.IO;
2015-05-27 17:57:34 +08:00
using System.Text;
using GameRes.Formats.Properties;
using GameRes.Formats.Strings;
using GameRes.Utility;
namespace GameRes.Formats.Entis
{
2015-05-27 17:57:34 +08:00
internal class NoaOptions : ResourceOptions
{
public string Scheme { get; set; }
public string PassPhrase { get; set; }
}
internal class NoaEntry : Entry
{
public byte[] Extra;
public uint Encryption;
public uint Attr;
}
2015-05-27 17:57:34 +08:00
internal class NoaArchive : ArcFile
{
public string Password;
public NoaArchive (ArcView arc, ArchiveFormat impl, ICollection<Entry> dir, string password = null)
: base (arc, impl, dir)
{
Password = password;
}
}
[Serializable]
public class NoaScheme : ResourceScheme
{
public Dictionary<string, Dictionary<string, string>> KnownKeys;
}
[Export(typeof(ArchiveFormat))]
public class NoaOpener : ArchiveFormat
{
public override string Tag { get { return "NOA"; } }
public override string Description { get { return "Entis GLS engine resource archive"; } }
public override uint Signature { get { return 0x69746e45; } } // 'Enti'
public override bool IsHierarchic { get { return true; } }
public override bool CanCreate { get { return false; } }
2015-05-27 17:57:34 +08:00
public NoaOpener ()
{
Extensions = new string[] { "noa", "dat" };
}
public static Dictionary<string, Dictionary<string, string>> KnownKeys =
new Dictionary<string, Dictionary<string, string>>();
2015-05-27 17:57:34 +08:00
public override ArcFile TryOpen (ArcView file)
{
if (!file.View.AsciiEqual (0, "Entis\x1a"))
return null;
uint id = file.View.ReadUInt32 (8);
if (0x02000400 != id)
return null;
var reader = new IndexReader (file);
if (!reader.ParseRoot() || 0 == reader.Dir.Count)
return null;
2015-05-27 17:57:34 +08:00
if (!reader.HasEncrypted)
return new ArcFile (file, this, reader.Dir);
var options = Query<NoaOptions> (arcStrings.ArcEncryptedNotice);
string password = null;
if (!string.IsNullOrEmpty (options.PassPhrase))
{
password = options.PassPhrase;
}
else if (!string.IsNullOrEmpty (options.Scheme))
{
Dictionary<string, string> filemap;
if (KnownKeys.TryGetValue (options.Scheme, out filemap))
{
var filename = Path.GetFileName (file.Name).ToLowerInvariant();
filemap.TryGetValue (filename, out password);
}
}
if (string.IsNullOrEmpty (password))
return new ArcFile (file, this, reader.Dir);
return new NoaArchive (file, this, reader.Dir, password);
}
public override Stream OpenEntry (ArcFile arc, Entry entry)
{
var nent = entry as NoaEntry;
if (null == nent || !arc.File.View.AsciiEqual (entry.Offset, "filedata"))
return arc.File.CreateStream (entry.Offset, entry.Size);
ulong size = arc.File.View.ReadUInt64 (entry.Offset+8);
2015-05-27 17:57:34 +08:00
if (size > int.MaxValue)
throw new FileSizeException();
2016-01-25 13:02:39 +08:00
if (size <= 4)
2015-05-27 17:57:34 +08:00
return Stream.Null;
2016-01-25 13:02:39 +08:00
if (EncType.ERISACode == nent.Encryption)
{
using (var enc = arc.File.CreateStream (entry.Offset+0x10, (uint)size-4))
return DecodeNemesis (enc);
}
var narc = arc as NoaArchive;
2015-05-27 17:57:34 +08:00
var input = arc.File.CreateStream (entry.Offset+0x10, (uint)size);
2016-01-25 13:02:39 +08:00
if (EncType.Raw == nent.Encryption || null == narc || null == narc.Password)
return input;
if (EncType.BSHFCrypt == nent.Encryption)
{
2016-01-25 13:02:39 +08:00
using (input)
return DecodeBSHF (input, narc.Password);
2015-05-27 17:57:34 +08:00
}
2016-01-25 13:02:39 +08:00
Trace.WriteLine (string.Format ("{0}: encryption scheme 0x{1:x8} not implemented",
nent.Name, nent.Encryption));
return input;
}
Stream DecodeNemesis (Stream input)
{
var decoder = new NemesisDecodeContext();
decoder.AttachInputFile (input);
decoder.PrepareToDecodeERISANCode();
var file = new MemoryStream ((int)input.Length);
var buffer = new byte[0x10000];
for (;;)
2015-05-27 17:57:34 +08:00
{
2016-01-25 13:02:39 +08:00
int read = (int)decoder.DecodeNemesisCodeBytes (buffer, 0x10000);
if (0 == read)
break;
file.Write (buffer, 0, read);
}
2016-01-25 13:02:39 +08:00
file.Position = 0;
return file;
}
Stream DecodeBSHF (Stream input, string password)
{
uint nTotalBytes = (uint)input.Length - 4;
var pBSHF = new BSHFDecodeContext (0x10000);
pBSHF.AttachInputFile (input);
pBSHF.PrepareToDecodeBSHFCode (password);
byte[] buf = new byte[nTotalBytes];
uint decoded = pBSHF.DecodeBSHFCodeBytes (buf, nTotalBytes);
if (decoded < nTotalBytes)
throw new EndOfStreamException ("Unexpected end of encrypted stream");
return new MemoryStream (buf);
2015-05-27 17:57:34 +08:00
}
public override ResourceOptions GetDefaultOptions ()
{
return new NoaOptions {
Scheme = Settings.Default.NOAScheme,
PassPhrase = Settings.Default.NOAPassPhrase,
};
}
public override object GetAccessWidget ()
{
return new GUI.WidgetNOA();
}
2016-01-25 13:02:39 +08:00
internal static class EncType
{
public const uint Raw = 0x00000000;
public const uint ERISACode = 0x80000010;
public const uint BSHFCrypt = 0x40000000;
public const uint SimpleCrypt32 = 0x20000000;
public const uint ERISACrypt = 0xC0000010;
public const uint ERISACrypt32 = 0xA0000010;
}
internal class IndexReader
{
ArcView m_file;
List<Entry> m_dir = new List<Entry>();
2015-05-27 17:57:34 +08:00
bool m_found_encrypted = false;
const char PathSeparatorChar = '/';
public List<Entry> Dir { get { return m_dir; } }
2015-05-27 17:57:34 +08:00
public bool HasEncrypted { get { return m_found_encrypted; } }
public IndexReader (ArcView file)
{
m_file = file;
}
public bool ParseRoot ()
{
return ParseDirEntry (0x40, "");
}
private bool ParseDirEntry (long dir_offset, string cur_dir)
{
if (!m_file.View.AsciiEqual (dir_offset, "DirEntry"))
return false;
long size = m_file.View.ReadInt64 (dir_offset+8);
if (size <= 0 || size > int.MaxValue)
return false;
if ((uint)size > m_file.View.Reserve (dir_offset+8, (uint)size))
return false;
long base_offset = dir_offset;
dir_offset += 0x10;
int count = m_file.View.ReadInt32 (dir_offset);
dir_offset += 4;
if (m_dir.Capacity < m_dir.Count+count)
m_dir.Capacity = m_dir.Count+count;
for (int i = 0; i < count; ++i)
{
var entry = new NoaEntry();
entry.Size = m_file.View.ReadUInt32 (dir_offset);
dir_offset += 8;
2015-05-27 17:57:34 +08:00
entry.Attr = m_file.View.ReadUInt32 (dir_offset);
dir_offset += 4;
2015-05-27 17:57:34 +08:00
entry.Encryption = m_file.View.ReadUInt32 (dir_offset);
2016-01-25 13:02:39 +08:00
m_found_encrypted = m_found_encrypted || (EncType.Raw != entry.Encryption && EncType.ERISACode != entry.Encryption);
dir_offset += 4;
2015-05-27 17:57:34 +08:00
entry.Offset = base_offset + m_file.View.ReadInt64 (dir_offset);
if (!entry.CheckPlacement (m_file.MaxOffset))
{
entry.Size = (uint)(m_file.MaxOffset - entry.Offset);
}
dir_offset += 0x10;
2015-05-27 17:57:34 +08:00
uint extra_length = m_file.View.ReadUInt32 (dir_offset);
dir_offset += 4;
if (extra_length > 0 && 0 == (entry.Attr & 0x70))
{
entry.Extra = new byte[extra_length];
if (entry.Extra.Length != m_file.View.Read (dir_offset, entry.Extra, 0, extra_length))
return false;
}
dir_offset += extra_length;
uint name_length = m_file.View.ReadUInt32 (dir_offset);
dir_offset += 4;
2015-05-27 17:57:34 +08:00
string name = m_file.View.ReadString (dir_offset, name_length);
dir_offset += name_length;
2015-05-27 17:57:34 +08:00
if (string.IsNullOrEmpty (cur_dir))
entry.Name = name;
else
entry.Name = cur_dir + PathSeparatorChar + name;
2015-05-27 17:57:34 +08:00
entry.Type = FormatCatalog.Instance.GetTypeFromName (name);
if (0x10 == entry.Attr)
{
if (!ParseDirEntry (entry.Offset+0x10, entry.Name))
return false;
}
else if (0x20 == entry.Attr || 0x40 == entry.Attr)
{
break;
}
else
{
m_dir.Add (entry);
}
}
return true;
}
}
public override ResourceScheme Scheme
{
get { return new NoaScheme { KnownKeys = KnownKeys }; }
set { KnownKeys = ((NoaScheme)value).KnownKeys; }
}
}
2015-05-27 17:57:34 +08:00
internal abstract class ERISADecodeContext
{
protected int m_nIntBufCount;
protected uint m_dwIntBuffer;
protected uint m_nBufferingSize;
protected uint m_nBufCount;
protected byte[] m_ptrBuffer;
protected int m_ptrNextBuf;
protected Stream m_pFile;
protected ERISADecodeContext m_pContext;
2015-05-27 17:57:34 +08:00
public ERISADecodeContext (uint nBufferingSize)
{
m_nIntBufCount = 0;
m_nBufferingSize = (nBufferingSize + 0x03) & ~0x03u;
m_nBufCount = 0;
m_ptrBuffer = new byte[nBufferingSize];
m_pFile = null;
m_pContext = null;
2015-05-27 17:57:34 +08:00
}
public void AttachInputFile (Stream file)
{
m_pFile = file;
m_pContext = null;
}
public void AttachInputContext (ERISADecodeContext context)
{
m_pFile = null;
m_pContext = context;
2015-05-27 17:57:34 +08:00
}
public uint ReadNextData (byte[] ptrBuffer, uint nBytes)
{
if (m_pFile != null)
{
return (uint)m_pFile.Read (ptrBuffer, 0, (int)nBytes);
}
else if (m_pContext != null)
{
return m_pContext.DecodeBytes (ptrBuffer, nBytes);
2015-05-27 17:57:34 +08:00
}
else
{
throw new ApplicationException ("Uninitialized ERISA encryption context");
}
}
public abstract uint DecodeBytes (Array ptrDst, uint nCount);
protected bool PrefetchBuffer()
{
if (0 == m_nIntBufCount)
{
if (0 == m_nBufCount)
{
m_ptrNextBuf = 0; // m_ptrBuffer;
m_nBufCount = ReadNextData (m_ptrBuffer, m_nBufferingSize);
if (0 == m_nBufCount)
{
return false;
}
if (0 != (m_nBufCount & 0x03))
{
uint i = m_nBufCount;
m_nBufCount += 4 - (m_nBufCount & 0x03);
while (i < m_nBufCount)
m_ptrBuffer[i ++] = 0;
}
}
m_nIntBufCount = 32;
m_dwIntBuffer =
((uint)m_ptrBuffer[m_ptrNextBuf] << 24) | ((uint)m_ptrBuffer[m_ptrNextBuf+1] << 16)
| ((uint)m_ptrBuffer[m_ptrNextBuf+2] << 8) | (uint)m_ptrBuffer[m_ptrNextBuf+3];
m_ptrNextBuf += 4;
m_nBufCount -= 4;
}
return true;
}
public void FlushBuffer ()
{
m_nIntBufCount = 0;
m_nBufCount = 0;
}
public int GetABit ()
{
if (!PrefetchBuffer())
{
return 1;
}
int nValue = ((int)m_dwIntBuffer) >> 31;
--m_nIntBufCount;
m_dwIntBuffer <<= 1;
return nValue;
}
public uint GetNBits (int n)
{
uint nCode = 0;
while (n != 0)
{
if (!PrefetchBuffer())
break;
int nCopyBits = Math.Min (n, m_nIntBufCount);
nCode = (nCode << nCopyBits) | (m_dwIntBuffer >> (32 - nCopyBits));
n -= nCopyBits;
m_nIntBufCount -= nCopyBits;
m_dwIntBuffer <<= nCopyBits;
}
return nCode;
}
}
internal class BSHFDecodeContext : ERISADecodeContext
{
ERIBshfBuffer m_pBshfBuf;
uint m_dwBufPos;
public BSHFDecodeContext (uint nBufferingSize) : base (nBufferingSize)
{
m_pBshfBuf = null;
}
public void PrepareToDecodeBSHFCode (string pszPassword)
{
if (null == m_pBshfBuf)
{
m_pBshfBuf = new ERIBshfBuffer();
}
if (string.IsNullOrEmpty (pszPassword))
{
pszPassword = " ";
}
int char_count = Encoding.ASCII.GetByteCount (pszPassword);
int length = Math.Max (char_count, 32);
var pass_bytes = new byte[length];
char_count = Encoding.ASCII.GetBytes (pszPassword, 0, pszPassword.Length, pass_bytes, 0);
if (char_count < 32)
{
pass_bytes[char_count++] = 0x1b;
for (int i = char_count; i < 32; ++i)
{
pass_bytes[i] = (byte)(pass_bytes[i % char_count] + pass_bytes[i - 1]);
}
}
m_pBshfBuf.m_strPassword = pass_bytes;
m_pBshfBuf.m_dwPassOffset = 0;
m_dwBufPos = 32;
}
public override uint DecodeBytes (Array ptrDst, uint nCount)
{
return DecodeBSHFCodeBytes (ptrDst as byte[], nCount);
}
public uint DecodeBSHFCodeBytes (byte[] ptrDst, uint nCount)
{
uint nDecoded = 0;
while (nDecoded < nCount)
{
if (m_dwBufPos >= 32)
{
for (int i = 0; i < 32; ++i)
{
if (0 == m_nBufCount)
{
m_ptrNextBuf = 0;
m_nBufCount = ReadNextData (m_ptrBuffer, m_nBufferingSize);
if (0 == m_nBufCount)
{
return nDecoded;
}
}
m_pBshfBuf.m_srcBSHF[i] = m_ptrBuffer[m_ptrNextBuf++];
m_nBufCount--;
}
m_pBshfBuf.DecodeBuffer();
m_dwBufPos = 0;
}
ptrDst[nDecoded++] = m_pBshfBuf.m_bufBSHF[m_dwBufPos++];
}
return nDecoded;
}
}
internal class ERIBshfBuffer
{
public byte[] m_strPassword;
public uint m_dwPassOffset = 0;
public byte[] m_bufBSHF = new byte[32];
public byte[] m_srcBSHF = new byte[32];
public byte[] m_maskBSHF = new byte[32];
public void DecodeBuffer ()
{
int nPassLen = m_strPassword.Length;
if ((int)m_dwPassOffset >= nPassLen)
{
m_dwPassOffset = 0;
}
for (int i = 0; i < 32; ++i)
{
m_bufBSHF[i] = 0;
m_maskBSHF[i] = 0;
}
int iPos = (int) m_dwPassOffset++;
int iBit = 0;
for (int i = 0; i < 256; ++i)
{
iBit = (iBit + m_strPassword[iPos++]) & 0xFF;
if (iPos >= nPassLen)
{
iPos = 0;
}
int iOffset = (iBit >> 3);
int iMask = (0x80 >> (iBit & 0x07));
while (0xFF == m_maskBSHF[iOffset])
{
iBit = (iBit + 8) & 0xFF;
iOffset = (iBit >> 3);
}
while (0 != (m_maskBSHF[iOffset] & iMask))
{
iBit ++;
iMask >>= 1;
if (0 == iMask)
{
iBit = (iBit + 8) & 0xFF;
iOffset = (iBit >> 3);
iMask = 0x80;
}
}
Debug.Assert (iMask != 0);
m_maskBSHF[iOffset] |= (byte) iMask;
if (0 != (m_srcBSHF[(i >> 3)] & (0x80 >> (i & 0x07))))
{
m_bufBSHF[iOffset] |= (byte)iMask;
}
}
}
}
}