Thư viện Word Search

Glasswall Embedded Engine cung cấp khả năng kiểm tra chuyên sâu tệp, khắc phục, làm sạch và báo cáo. Engine này phân rã một tệp thành các thành phần cấu trúc của nó và xây dựng một biểu diễn nội bộ dạng cây của tệp. Nó duyệt qua từng nút của cây, kiểm tra, sửa chữa và làm sạch các mục nội dung trước khi tái tạo một tệp mới.

Glasswall Embedded Engine cũng cung cấp khả năng xuất và nhập biểu diễn nội bộ của engine về cấu trúc tệp ở một định dạng trung gian như XML. Điều này cho phép các thành phần nội bộ của tệp được cung cấp cho các chương trình bên ngoài để xử lý bổ sung, trước khi tái cấu thành tệp để bao gồm các thành phần đã được sửa đổi từ bên ngoài đó.

Engine Glasswall Word Search được xây dựng dựa trên khả năng xuất và nhập, thực hiện tìm kiếm văn bản trong nội dung và siêu dữ liệu của tệp. Các chuỗi tìm kiếm, quản lý nội dung và quy tắc biên tập được cấu hình thông qua một tệp XML. Một ánh xạ thay thế ký tự do người dùng cấu hình, được định nghĩa ở dạng JSON, được sử dụng để hỗ trợ che giấu văn bản. Engine cũng đi kèm hỗ trợ biểu thức chính quy tích hợp sẵn.

Cấu hình Word Search​

Cấu hình Word Search chỉ định văn bản cần tìm kiếm hoặc biểu thức chính quy sẽ được áp dụng và cách xử lý khi tìm thấy trong tài liệu. Cấu hình Word Search là một phần mở rộng của quản lý nội dung Glasswall.

Các tệp policy và schema mẫu​

Có thể tìm thấy các tệp policy Word Search mẫu và từ điển homoglyph trong thư mục /configs/sdk_word_search của gói phát hành. Có thể tìm thấy XSD của Word Search trong thư mục /schemas/sdk_word_search của gói phát hành.

Policy cấu hình mẫu​

Cài đặt văn bản​

Các phần sau minh họa các textSetting khác nhau có thể được định nghĩa trong một policy cấu hình. Để biết thêm thông tin về các cài đặt khác nhau, hãy tham khảo trang Word Search & Redaction.

Cho phép​

<textSearchConfig libVersion="core2">
	<textList>
		<textItem>
            <regex>((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}</regex>
            <textSetting>allow</textSetting>
        </textItem>
        <textItem>
            <text>Glasswall</text>
            <textSetting>allow</textSetting>
        </textItem>
	</textList>
</textSearchConfig>

Không cho phép​

<textSearchConfig libVersion="core2">
    <textList>
        <textItem>
            <regex>((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}</regex>
            <textSetting>disallow</textSetting>
        </textItem>
        <textItem>
            <text>Glasswall</text>
            <textSetting>disallow</textSetting>
        </textItem>
    </textList>
</textSearchConfig>

Che​

<textSearchConfig libVersion="core2">
    <textList>
        <textItem>
            <regex>((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}</regex>
            <textSetting replacementChar="*">redact</textSetting>
        </textItem>
        <textItem>
            <text>Glasswall</text>
            <textSetting replacementChar="*">redact</textSetting>
        </textItem>
    </textList>
</textSearchConfig>

Bắt buộc​

<textSearchConfig libVersion="core2">
    <textList>
        <textItem>
            <regex>((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}</regex>
            <textSetting>require</textSetting>
        </textItem>
    </textList>
</textSearchConfig>

Cấu hình hệ thống​

Tương tự như engine Glasswall cốt lõi, có thể tìm thấy các tùy chọn bổ sung trong phần sysConfig. Các tùy chọn này kiểm soát hành vi của engine Word Search trong khi xử lý các tệp đầu vào.

<sysConfig>
    <!--interchange_type must always be specified with the value "xml"-->
    <interchange_type>xml</interchange_type>
    <!--Enables/disables processing of text files. False by default.-->
    <enable_text_support>false</enable_text_support>
</sysConfig>

Các giới hạn đã biết​

• Không thể xử lý đồng thời cả tệp Office và tệp văn bản
• Khi xử lý tệp văn bản, cần phải định nghĩa ít nhất một policy require
• interchange_type phải luôn được chỉ định là xml trong sysConfig
• Configuration policy that has a combination of the following textSettings with the same text/regex defined will always process the file:
  • require và redact
  • require và disallow
  • redact và allow
  • allow và disallow

Ví dụ về cấu hình homoglyph JSON​

Tệp JSON cho phép người dùng tạo ánh xạ giữa các ký tự và các homoglyph tương ứng. Điều này cho phép engine xem xét các homoglyph khi tạo biểu thức tìm kiếm, hỗ trợ các homograph (từ trông giống nhau) và văn bản bị làm rối.

{
	"!": "ǃⵑ",
	"$": "＄",
	"%": "％",
	"&": "ꝸ＆",
	"'": "`´ʹʻʼʽʾˈˊˋ˴ʹ΄՚՝י׳ߴߵᑊᛌ᾽᾿`´῾‘’‛′‵ꞌ＇｀𖽑𖽒",
	"(": "❨❲〔﴾（［",
	")": "❩❳〕﴿）］",
	"*": "٭⁎∗＊𐌟",
	"+": "᛭＋𐊛",
	",": "¸؍٫‚ꓹ，",
	"-": "˗۔‐‑‒–⁃−➖Ⲻ﹘",
	".": "٠۰܁܂․ꓸ꘎．𐩐𝅭",
	"/": "᜵⁁⁄∕╱⟋⧸Ⳇ⼃〳ノ㇓丿／𝈺",
	"0": "OoΟοσОоՕօסه٥ھہە۵߀०০੦૦ଠ୦௦ం౦ಂ೦ംഠ൦ං๐໐ဝ၀ჿዐᴏᴑℴⲞⲟⵔ〇ꓳꬽﮦﮧﮨﮩﮪﮫﮬﮭﻩﻪﻫﻬ０Ｏｏ𐊒𐊫𐐄𐐬𐓂𐓪𐔖𑓐𑢵𑣈𑣗𑣠𝐎𝐨𝑂𝑜𝑶𝒐𝒪𝓞𝓸𝔒𝔬𝕆𝕠𝕺𝖔𝖮𝗈𝗢𝗼𝘖𝘰𝙊𝙤𝙾𝚘𝚶𝛐𝛔𝛰𝜊𝜎𝜪𝝄𝝈𝝤𝝾𝞂𝞞𝞸𝞼𝟎𝟘𝟢𝟬𝟶𞸤𞹤𞺄",
	"1": "Il|ƖǀΙІӀ׀וןا١۱ߊᛁℐℑℓⅠⅼ∣⏽Ⲓⵏꓲﺍﺎ１Ｉｌ￨𐊊𐌉𐌠𖼨𝐈𝐥𝐼𝑙𝑰𝒍𝓁𝓘𝓵𝔩𝕀𝕝𝕴𝖑𝖨𝗅𝗜𝗹𝘐𝘭𝙄𝙡𝙸𝚕𝚰𝛪𝜤𝝞𝞘𝟏𝟙𝟣𝟭𝟷𞣇𞸀𞺀",
	"2": "ƧϨᒿꙄꛯꝚ２𝟐𝟚𝟤𝟮𝟸",
	"3": "ƷȜЗӠⳌꝪꞫ３𑣊𖼻𝈆𝟑𝟛𝟥𝟯𝟹",
	"4": "Ꮞ４𑢯𝟒𝟜𝟦𝟰𝟺",
	"5": "Ƽ５𑢻𝟓𝟝𝟧𝟱𝟻",
	"6": "бᏮⳒ６𑣕𝟔𝟞𝟨𝟲𝟼",
	"7": "７𐓒𑣆𝈒𝟕𝟟𝟩𝟳𝟽",
	"8": "Ȣȣ৪੪ଃ８𐌚𝟖𝟠𝟪𝟴𝟾𞣋",
	"9": "৭੧୨൭ⳊꝮ９𑢬𑣌𑣖𝟗𝟡𝟫𝟵𝟿",
	"A": "4ΑАᎪᗅᴀꓮꭺＡ𐊠𖽀𝐀𝐴𝑨𝒜𝓐𝔄𝔸𝕬𝖠𝗔𝘈𝘼𝙰𝚨𝛢𝜜𝝖𝞐",
	"B": "ʙΒВвᏴᏼᗷᛒℬꓐꞴＢ𐊂𐊡𐌁𝐁𝐵𝑩𝓑𝔅𝔹𝕭𝖡𝗕𝘉𝘽𝙱𝚩𝛣𝜝𝝗𝞑",
	"C": "ϹСᏟℂℭⅭⲤꓚＣ𐊢𐌂𐐕𐔜𑣩𑣲𝐂𝐶𝑪𝒞𝓒𝕮𝖢𝗖𝘊𝘾𝙲🝌",
	"D": "ᎠᗞᗪᴅⅅⅮꓓꭰＤ𝐃𝐷𝑫𝒟𝓓𝔇𝔻𝕯𝖣𝗗𝘋𝘿𝙳",
	"E": "ΕЕᎬᴇℰ⋿ⴹꓰꭼＥ𐊆𑢦𑢮𝐄𝐸𝑬𝓔𝔈𝔼𝕰𝖤𝗘𝘌𝙀𝙴𝚬𝛦𝜠𝝚𝞔",
	"F": "ϜᖴℱꓝꞘＦ𐊇𐊥𐔥𑢢𑣂𝈓𝐅𝐹𝑭𝓕𝔉𝔽𝕱𝖥𝗙𝘍𝙁𝙵𝟊",
	"G": "ɢԌԍᏀᏳᏻꓖꮐＧ𝐆𝐺𝑮𝒢𝓖𝔊𝔾𝕲𝖦𝗚𝘎𝙂𝙶",
	"H": "ʜΗНнᎻᕼℋℌℍⲎꓧꮋＨ𐋏𝐇𝐻𝑯𝓗𝕳𝖧𝗛𝘏𝙃𝙷𝚮𝛨𝜢𝝜𝞖",
	"I": "",
	"J": "ͿЈᎫᒍᴊꓙꞲꭻＪ𝐉𝐽𝑱𝒥𝓙𝔍𝕁𝕵𝖩𝗝𝘑𝙅𝙹",
	"K": "ΚКᏦᛕKⲔꓗＫ𐔘𝐊𝐾𝑲𝒦𝓚𝔎𝕂𝕶𝖪𝗞𝘒𝙆𝙺𝚱𝛫𝜥𝝟𝞙",
	"L": "ʟᏞᒪℒⅬⳐⳑꓡꮮＬ𐐛𐑃𐔦𑢣𑢲𖼖𝈪𝐋𝐿𝑳𝓛𝔏𝕃𝕷𝖫𝗟𝘓𝙇𝙻",
	"M": "ΜϺМᎷᗰᛖℳⅯⲘꓟＭ𐊰𐌑𝐌𝑀𝑴𝓜𝔐𝕄𝕸𝖬𝗠𝘔𝙈𝙼𝚳𝛭𝜧𝝡𝞛",
	"N": "ɴΝℕⲚꓠＮ𐔓𝐍𝑁𝑵𝒩𝓝𝔑𝕹𝖭𝗡𝘕𝙉𝙽𝚴𝛮𝜨𝝢𝞜",
	"O": "0",
	"P": "ΡРᏢᑭᴘᴩℙⲢꓑꮲＰ𐊕𝐏𝑃𝑷𝒫𝓟𝔓𝕻𝖯𝗣𝘗𝙋𝙿𝚸𝛲𝜬𝝦𝞠",
	"Q": "ℚⵕＱ𝐐𝑄𝑸𝒬𝓠𝔔𝕼𝖰𝗤𝘘𝙌𝚀",
	"R": "ƦʀᎡᏒᖇᚱℛℜℝꓣꭱꮢＲ𐒴𖼵𝈖𝐑𝑅𝑹𝓡𝕽𝖱𝗥𝘙𝙍𝚁",
	"S": "$ЅՏᏕᏚꓢＳ𐊖𐐠𖼺𝐒𝑆𝑺𝒮𝓢𝔖𝕊𝕾𝖲𝗦𝘚𝙎𝚂",
	"T": "ŤΤτТтᎢᴛ⊤⟙ⲦꓔꭲＴ𐊗𐊱𐌕𑢼𖼊𝐓𝑇𝑻𝒯𝓣𝔗𝕋𝕿𝖳𝗧𝘛𝙏𝚃𝚻𝛕𝛵𝜏𝜯𝝉𝝩𝞃𝞣𝞽🝨",
	"U": "Սሀᑌ∪⋃ꓴＵ𐓎𑢸𖽂𝐔𝑈𝑼𝒰𝓤𝔘𝕌𝖀𝖴𝗨𝘜𝙐𝚄",
	"V": "Ѵ٧۷ᏙᐯⅤⴸꓦꛟＶ𐔝𑢠𖼈𝈍𝐕𝑉𝑽𝒱𝓥𝔙𝕍𝖁𝖵𝗩𝘝𝙑𝚅",
	"W": "ԜᎳᏔꓪＷ𑣦𑣯𝐖𝑊𝑾𝒲𝓦𝔚𝕎𝖂𝖶𝗪𝘞𝙒𝚆",
	"X": "ΧХ᙭ᚷⅩ╳ⲬⵝꓫꞳＸ𐊐𐊴𐌗𐌢𐔧𑣬𝐗𝑋𝑿𝒳𝓧𝔛𝕏𝖃𝖷𝗫𝘟𝙓𝚇𝚾𝛸𝜲𝝬𝞦",
	"Y": "ΥϒУҮᎩᎽⲨꓬＹ𐊲𑢤𖽃𝐘𝑌𝒀𝒴𝓨𝔜𝕐𝖄𝖸𝗬𝘠𝙔𝚈𝚼𝛶𝜰𝝪𝞤",
	"Z": "ΖᏃℤℨꓜＺ𐋵𑢩𑣥𝐙𝑍𝒁𝒵𝓩𝖅𝖹𝗭𝘡𝙕𝚉𝚭𝛧𝜡𝝛𝞕",
	"a": "@ɑαа⍺ａ𝐚𝑎𝒂𝒶𝓪𝔞𝕒𝖆𝖺𝗮𝘢𝙖𝚊𝛂𝛼𝜶𝝰𝞪",
	"b": "ƄЬᏏᖯｂ𝐛𝑏𝒃𝒷𝓫𝔟𝕓𝖇𝖻𝗯𝘣𝙗𝚋",
	"c": "ϲсᴄⅽⲥꮯｃ𐐽𝐜𝑐𝒄𝒸𝓬𝔠𝕔𝖈𝖼𝗰𝘤𝙘𝚌",
	"d": "ԁᏧᑯⅆⅾꓒｄ𝐝𝑑𝒅𝒹𝓭𝔡𝕕𝖉𝖽𝗱𝘥𝙙𝚍",
	"e": "еҽ℮ℯⅇꬲｅ𝐞𝑒𝒆𝓮𝔢𝕖𝖊𝖾𝗲𝘦𝙚𝚎",
	"f": "ſϝքẝꞙꬵｆ𝐟𝑓𝒇𝒻𝓯𝔣𝕗𝖋𝖿𝗳𝘧𝙛𝚏𝟋",
	"g": "ƍɡցᶃℊｇ𝐠𝑔𝒈𝓰𝔤𝕘𝖌𝗀𝗴𝘨𝙜𝚐",
	"h": "һհᏂℎｈ𝐡𝒉𝒽𝓱𝔥𝕙𝖍𝗁𝗵𝘩𝙝𝚑",
	"i": "ıɩɪ˛ͺιіӏᎥιℹⅈⅰ⍳ꙇꭵｉ𑣃𝐢𝑖𝒊𝒾𝓲𝔦𝕚𝖎𝗂𝗶𝘪𝙞𝚒𝚤𝛊𝜄𝜾𝝸𝞲",
	"j": "ϳјⅉｊ𝐣𝑗𝒋𝒿𝓳𝔧𝕛𝖏𝗃𝗷𝘫𝙟𝚓",
	"k": "ｋ𝐤𝑘𝒌𝓀𝓴𝔨𝕜𝖐𝗄𝗸𝘬𝙠𝚔",
	"l": "1",
	"m": "ｍ",
	"n": "ոռｎ𝐧𝑛𝒏𝓃𝓷𝔫𝕟𝖓𝗇𝗻𝘯𝙣𝚗",
	"o": "",
	"p": "ρϱр⍴ⲣｐ𝐩𝑝𝒑𝓅𝓹𝔭𝕡𝖕𝗉𝗽𝘱𝙥𝚙𝛒𝛠𝜌𝜚𝝆𝝔𝞀𝞎𝞺𝟈",
	"q": "ԛգզｑ𝐪𝑞𝒒𝓆𝓺𝔮𝕢𝖖𝗊𝗾𝘲𝙦𝚚",
	"r": "гᴦⲅꭇꭈꮁｒ𝐫𝑟𝒓𝓇𝓻𝔯𝕣𝖗𝗋𝗿𝘳𝙧𝚛",
	"s": "$ƽѕꜱꮪｓ𐑈𑣁𝐬𝑠𝒔𝓈𝓼𝔰𝕤𝖘𝗌𝘀𝘴𝙨𝚜",
	"t": "ｔ𝐭𝑡𝒕𝓉𝓽𝔱𝕥𝖙𝗍𝘁𝘵𝙩𝚝",
	"u": "ʋυսᴜꞟꭎꭒｕ𐓶𑣘𝐮𝑢𝒖𝓊𝓾𝔲𝕦𝖚𝗎𝘂𝘶𝙪𝚞𝛖𝜐𝝊𝞄𝞾",
	"v": "νѵטᴠⅴ∨⋁ꮩｖ𑜆𑣀𝐯𝑣𝒗𝓋𝓿𝔳𝕧𝖛𝗏𝘃𝘷𝙫𝚟𝛎𝜈𝝂𝝼𝞶",
	"w": "ɯѡԝաᴡꮃｗ𑜊𑜎𑜏𝐰𝑤𝒘𝓌𝔀𝔴𝕨𝖜𝗐𝘄𝘸𝙬𝚠",
	"x": "×хᕁᕽ᙮ⅹ⤫⤬⨯ｘ𝐱𝑥𝒙𝓍𝔁𝔵𝕩𝖝𝗑𝘅𝘹𝙭𝚡",
	"y": "ɣʏγуүყᶌỿℽꭚｙ𑣜𝐲𝑦𝒚𝓎𝔂𝔶𝕪𝖞𝗒𝘆𝘺𝙮𝚢𝛄𝛾𝜸𝝲𝞬",
	"z": "ᴢꮓｚ𑣄𝐳𝑧𝒛𝓏𝔃𝔷𝕫𝖟𝗓𝘇𝘻𝙯𝚣",
	"£": "₤",
	"©": "Ⓒ",
	"®": "Ⓡ"
}

Ví dụ về báo cáo phân tích​

Đây là ví dụ về báo cáo phân tích được tạo khi chuỗi tìm kiếm được đặt thành 'Glasswall', bất kể textSetting được sử dụng. Báo cáo này bao gồm ItemMatchCount cho mọi mẫu được khớp trong một tệp nhất định.

<gw:WordItem>
    <gw:Name>Glasswall</gw:Name>
    <gw:ItemMatchCount>1</gw:ItemMatchCount>
    <gw:Locations>
        <gw:Location>
            <gw:Offset>463</gw:Offset>
            <gw:Page>0</gw:Page>
            <gw:Paragraph>0</gw:Paragraph>
        </gw:Location>
    </gw:Locations>
</gw:WordItem>

Các hàm API​

Trạng thái​

Các API GwWordSearch và GwWordSearchDone trả về một Status cho biết kết quả của lệnh gọi API. API GwWordSearchTranslateStatus trả về mô tả cho Status được truyền vào.

C++​

Mỗi API trả về một Status, được định nghĩa như sau:

enum Status {
    ws_disallowedItemFound = -1024,
    ws_requiredItemNotFound = -1025,
    ws_illegalActionRedact = -1026,
    ws_illegalActionRequire = -1027,
    ws_illegalActionNoRequire = -1028,
    ws_filetypeUnsupported = -1029,
    eFail = 0,
    eSuccess = 1,
};

C#​

Để tích hợp Glasswall Word Search trong C#, bắt buộc phải có Word Search C# wrapper của Glasswall. Mỗi API trả về một kiểu WordSearchStatus, được định nghĩa như sau:

/// <summary>
///     Indicates whether the Word Search process was successful (WordSearchStatus.Success)
///     or not (WordSearchStatus.Fail). Zero or negative values indicate a failure.
/// </summary>
public enum WordSearchStatus
{
    DisallowedItemFound = -1024,
    RequiredItemNotFound = -1025,
    IllegalActionRedact = -1026,
    IllegalActionRequire = -1027,
    IllegalActionNoRequire = -1028,
    FiletypeUnsupported = -1029,
    Fail = 0,
    Success
}

Java​

Để tích hợp Glasswall Word Search trong java, cần có Word Search Java wrapper của Glasswall. Mỗi API trả về một kiểu GlasswallWordSearchResult`, được định nghĩa như sau:

package com.glasswallsolutions;

/**
 * Class used to hold the results from a Word Search process.
 */
public class GlasswallWordSearchResult
{
    /**
     * The XML analysis report
     */
    public String report;

    /**
     * The processed document
     */
    public byte[] outputDocument;

    /**
     * boolean indicating whether the process was successful (true) or not (false)
     */
    public boolean success;

    public GlasswallWordSearchResult()
    {
        report = null;
        outputDocument = null;
        success = false;
    }
}

Python​

Để tích hợp Glasswall Word Search trong Python, cần có Glasswall Python wrapper. Mỗi API trả về một đối tượng GwReturnObj chung, đối tượng này sẽ chứa các thuộc tính: "status" (int), "output_file" (bytes), "output_report" (bytes). Các trạng thái int được định nghĩa như sau:

# glasswall\libraries\word_search\successes.py

class Success(WordSearchSuccess):
    """ WordSearch success code 1. """
    pass


success_codes = {
    1: Success,
}

# glasswall\libraries\word_search\errors.py

class UnknownErrorCode(WordSearchError):
    """ Unknown error code. """
    pass

class Fail(WordSearchError):
    """ WordSearch error code 0. """
    pass


class DisallowedItemFound(WordSearchError):
    """ WordSearch error code -1024. Item disallowed by policy found in file. """
    pass


class RequiredItemNotFound(WordSearchError):
    """ WordSearch error code -1025. Item required by policy not found in file. """
    pass


class IllegalActionRedact(WordSearchError):
    """ WordSearch error code -1026. Redact action specified but filetype doesn't support redaction. """
    pass


class IllegalActionRequire(WordSearchError):
    """ WordSearch error code -1027. Require action specified but filetype doesn't support redaction. """
    pass


class IllegalActionNoRequire(WordSearchError):
    """ WordSearch error code -1028. Require action not specified but filetype needs one. """
    pass


class FiletypeUnsupported(WordSearchError):
    """ WordSearch error code -1029. Filetype supported by Editor but not by Word Search. """
    pass


error_codes = {
    0: Fail,
    -1024: DisallowedItemFound,
    -1025: RequiredItemNotFound,
    -1026: IllegalActionRedact,
    -1027: IllegalActionRequire,
    -1028: IllegalActionNoRequire,
    -1029: FiletypeUnsupported,
}

JavaScript​

Để tích hợp Glasswall Word Search trong JavaScript, cần có Word Search JavaScript wrapper của Glasswall. Mỗi API trả về một kiểu WordSearchStatus, được định nghĩa như sau:

/**
 * Used to indicate whether the Word Search process was successful or not
 */
export const enum WordSearchStatus {
    ws_disallowedItemFound = -1024,     
    ws_requiredItemNotFound = -1025,    
    ws_illegalActionRedact = -1026,     
    ws_illegalActionRequire = -1027,    
    ws_illegalActionNoRequire = -1028,  
    ws_filetypeUnsupported = -1029,
    eFail    = 0,
    eSuccess = 1,
}

GwWordSearch​

Phần này được dùng để gọi engine Word Search, xử lý tệp đầu vào được chỉ định và tạo ra một tệp đầu ra cùng với báo cáo phân tích Word Search.

C++​

Status GwWordSearch(
    void* input_buffer,
    size_t input_buffer_len,
    void** output_buffer,
    size_t* output_buffer_len,
    void** output_report_buffer,
    size_t* output_report_buffer_len,
    const char* homoglpyhs,
    const char* xml_config_string
)

C#​

Để tích hợp Glasswall Word Search trong C#, bắt buộc phải có wrapper C# cho Word Search của Glasswall.

public WordSearchStatus GwWordSearch(
    byte[] inputBuffer,
    out byte[] outputFileBuffer,
    out String outputAnalysisReport,
    string homoglyphs,
    string xmlConfigString
)

Java​

Để tích hợp Glasswall Word Search trong Java, cần có trình bao bọc Word Search Java của Glasswall.

public native GlasswallWordSearchResult wordSearch(
    byte[] inputDocument,
    String homoglyphs,
    String xmlConfig
)

Lưu ý: Không giống như một số ngôn ngữ được hỗ trợ khác, toàn bộ đầu ra được trả về trong đối tượng GlasswallWordSearchResult cho Java.

Python​

Để tích hợp Glasswall Word Search trong Python, cần có trình bao bọc Python của Glasswall.

# glasswall\libraries\word_search\word_search.py

def redact_file(self, input_file: Union[str, bytes, bytearray, io.BytesIO], content_management_policy: Union[str, bytes, bytearray, io.BytesIO], output_file: Union[None, str] = None, output_report: Union[None, str] = None, homoglyphs: Union[None, str, bytes, bytearray, io.BytesIO] = None, raise_unsupported: bool = True):
    """ Redacts text from input_file using the given content_management_policy and homoglyphs file, optionally writing the redacted file and analysis report to the paths specified by output_file and output_report.

    Args:
        input_file (Union[str, bytes, bytearray, io.BytesIO]): The input file path or bytes.
        content_management_policy (Union[str, bytes, bytearray, io.BytesIO)]): The content management policy to apply.
        output_file (Union[None, str], optional): Default None. If str, write output_file to that path.
        output_report (Union[None, str], optional): Default None. If str, write output_file to that path.
        homoglyphs (Union[None, str, bytes, bytearray, io.BytesIO)], optional): Default None. The homoglyphs json file path or bytes.
        raise_unsupported (bool, optional): Default True. Raise exceptions when Glasswall encounters an error. Fail silently if False.

    Returns:
        gw_return_object (glasswall.GwReturnObj): An instance of class glasswall.GwReturnObj containing attributes: "status" (int), "output_file" (bytes), "output_report" (bytes)
    """


def redact_directory(self, input_directory: str, content_management_policy: Union[str, bytes, bytearray, io.BytesIO, glasswall.content_management.policies.policy.Policy], output_directory: Optional[str] = None, output_report_directory: Optional[str] = None, homoglyphs: Union[None, str, bytes, bytearray, io.BytesIO] = None, raise_unsupported: bool = True):
    """ Redacts all files in a directory and it's subdirectories using the given content_management_policy and homoglyphs file. The redacted files are written to output_directory maintaining the same directory structure as input_directory.

    Args:
        input_directory (str): The input directory containing files to redact.
        output_directory (str): The output directory where the redacted files will be written.
        output_report_directory (Optional[str], optional): Default None. If str, the output directory where analysis reports for each redacted file will be written.
        content_management_policy (Union[str, bytes, bytearray, io.BytesIO)]): The content management policy to apply.
        homoglyphs (Union[None, str, bytes, bytearray, io.BytesIO)], optional): Default None. The homoglyphs file path, str, or bytes.
        raise_unsupported (bool, optional): Default True. Raise exceptions when Glasswall encounters an error. Fail silently if False.

    Returns:
        redacted_files_dict (dict): A dictionary of file paths relative to input_directory, and glasswall.GwReturnObj with attributes: "status" (int), "output_file" (bytes), "output_report" (bytes)
    """

Lưu ý: Không giống như một số ngôn ngữ được hỗ trợ khác, mọi đầu ra đều được trả về trong đối tượng GwReturnObj cho Python.

JavaScript​

/**
     * Perform word search on input buffer, using the applied config and homoglyphs
     * @param {Buffer} inputBuffer A buffer containing the contents of the document to be processed.
     * @param {String} homoglyphs A homoglyphs file that will be used as part of the Word Search process (UTF-8 string).
     * @param {String} configXml The content management XML policy (utf-8 string).
     * @returns {WordSearchResult} The result from Word Search.
     */
    wordSearch(inputBuffer: Buffer, homoglyphs: string, configXml: string): WordSearchResult

Lưu ý: Không giống như một số ngôn ngữ được hỗ trợ khác, toàn bộ đầu ra được trả về trong đối tượng WordSearchResult đối với JavaScript.

GWWordSearchDone​

Điều này được dùng để giải phóng mọi tài nguyên đã được cấp phát bởi công cụ Word Search. Hàm này cần được gọi sau mỗi lần gọi tới hàm GwWordSearch, nếu không sẽ xảy ra rò rỉ bộ nhớ.

Lệnh gọi API này chỉ cần thiết trong C++.

C++​

Status GwWordSearchDone(
    void** output_buffer,
    size_t* output_buffer_len,
    void** output_report_buffer,
    size_t* output_report_buffer_len)

Các ngôn ngữ khác​

Đối với tất cả các ngôn ngữ được bao phủ bởi các wrapper của Glasswall, hàm API GwWordSearchDone được gọi nội bộ bên trong wrapper, nghĩa là API này không được hiển thị cho người dùng.

GwWordSearchVersion​

Điều này được dùng để truy xuất số phiên bản hiện tại của thư viện.

C++​

const char* GwWordSearchVersion(void)

GwWordSearchTranslateStatus​

Chuyển đổi mã lỗi được cung cấp thành thông báo lỗi thân thiện với người dùng.

C++​

const char* GwWordSearchTranslateStatus(Status errorCode)

Các sự cố thường gặp​

Word Search không xử lý tệp​

Khi chạy Word Search, vui lòng đảm bảo rằng tất cả các thư viện Embedded Engine đều nằm trong cùng một thư mục, và thư mục đó cũng cần được đặt làm thư mục làm việc hiện tại. Glasswall tìm kiếm các phần phụ thuộc của nó trong thư mục làm việc hiện tại và nếu không tìm thấy chúng thì các tệp sẽ không được xử lý đúng cách. Đồng thời hãy đảm bảo có khóa giấy phép hợp lệ.

Ví dụ sử dụng​

Ở đây chúng tôi có một ứng dụng ví dụ nhận một tệp đầu vào, xử lý tệp đó bằng công cụ Glasswall Word Search, rồi tạo ra một tệp đầu ra cùng với một báo cáo phân tích Word Search. Ứng dụng ví dụ này yêu cầu các tham số dòng lệnh sau:

1. Đường dẫn đến tệp XML cấu hình quản lý nội dung.
2. Đường dẫn đến tệp homoglyphs.
3. Đường dẫn đến tệp đầu vào cần được xử lý.
4. Đường dẫn đến tệp đầu ra nơi tệp đã xử lý sẽ được lưu trữ.

C++​

#include <iostream>
#include <fstream>
#include <string>
#include <vector>
#include <cstddef>
#include <stdexcept>

#include "api.h"

using namespace std;

// Read the file into a buffer
vector<uint8_t> readFile(ifstream &fileHandle, const string &filePath, bool nullTerminator)
{
    fileHandle.exceptions(ifstream::failbit | ifstream::badbit);
    fileHandle.open(filePath.c_str(), ios::binary | ios::ate);

    vector<uint8_t> data;
    streamsize size = fileHandle.tellg();
    fileHandle.seekg(0, ios::beg);

    data.resize(size + 1);
    fileHandle.read(reinterpret_cast<char *>(data.data()), size);

    if (nullTerminator)
    {
        data.push_back(0);
    }

    return data;
}

int main(int argc, char **argv)
{
    if (argc != 5)
    {
        cerr << "Usage: <Path to XML Config> <Path to Homoglyphs> <Input file> <Output file>" << endl;
        return -1;
    }

    // Read commandline arguments
    string xmlFilePath(argv[1]);
    string homoglyphsFilePath(argv[2]);
    string inputFilePath(argv[3]);
    string outputFilePath(argv[4]);

    // Create file handles for input files
    ifstream xmlFileHandle;
    ifstream homoglyphsFileHandle;
    ifstream inputFileHandle;

    // Read files into buffers
    vector<uint8_t> xmlBuffer = readFile(xmlFileHandle, xmlFilePath, true);                         // Buffer containing the XML content management settings. This is null terminated
    vector<uint8_t> homoglyphsBuffer = readFile(homoglyphsFileHandle, homoglyphsFilePath, true);    // Buffer containing the homoglyphs. This is null terminated
    vector<uint8_t> inputBuffer = readFile(inputFileHandle, inputFilePath, false);                  // Buffer containing the input file to be processed

    // Create variables for output buffers
    void * outputBuffer = nullptr;          // Output buffer for processed file
    size_t outputBufferSize = 0;            // Output buffer size
    void * outputReportBuffer = nullptr;    // Output buffer for analysis report file
    size_t outputReportBufferSize = 0;      // Output analysis report buffer size

    // Run Word Search and redact
    Status status = GwWordSearch(inputBuffer.data(), inputBuffer.size(), &outputBuffer, &outputBufferSize, &outputReportBuffer, &outputReportBufferSize, reinterpret_cast<const char*>(homoglyphsBuffer.data()), reinterpret_cast<const char *>(xmlBuffer.data()));

    if (status == Status::eSuccess)
    {
        // Write out the processed output file if the Word Search and redact was successful
        ofstream outputFileHandle(outputFilePath, ios::binary | ios::trunc);

        if (outputFileHandle.is_open())
        {
            outputFileHandle.write(static_cast<const char *>(outputBuffer), outputBufferSize);
        }

        outputFileHandle.close();
    }

    // Write out the analysis report file
    ofstream analysisFileHandle(outputFilePath + ".xml", ios::binary | ios::trunc);

    if (analysisFileHandle.is_open())
    {
        analysisFileHandle.write(static_cast<const char *>(outputReportBuffer), outputReportBufferSize);
    }

    analysisFileHandle.close();

    // Call done to release any allocated resources
    GwWordSearchDone(&outputBuffer, &outputBufferSize, &outputReportBuffer, &outputReportBufferSize);

    return 0;
}

C#​

using System;
using System.IO;

namespace glasswall.word.search.csharp.testing
{
    internal class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Word Search test");
            if (args.Length != 4)
            {
                Console.WriteLine("usage: <Xml Config> <Homoglyphs> <Input Directory> <OutputDirectory>");
                Console.WriteLine("Parameters specified: \n{0}", string.Join("\n", args));
                return;
            }

            string xmlConfigPath = args[0];
            string homoglyphsPath = args[1];
            string inputDirectory = args[2];
            string outputDirectory = args[3];

            if (!File.Exists(xmlConfigPath))
            {
                Console.Error.WriteLine("Xml config does not exist: {0}", xmlConfigPath);
                return;
            }

            if (!File.Exists(homoglyphsPath))
            {
                Console.Error.WriteLine("Homoglyphs does not exist: {0}", homoglyphsPath);
                return;
            }

            if (!Directory.Exists(inputDirectory))
            {
                Console.Error.WriteLine("Input directory does not exist: {0}", inputDirectory);
                return;
            }

            Directory.CreateDirectory(outputDirectory);

            using (FileStream fileStream = new FileStream(Path.Combine(outputDirectory, "ProcessLog.txt"), FileMode.OpenOrCreate, FileAccess.Write))
            {
                using (StreamWriter writer = new StreamWriter(fileStream))
                {
                    writer.WriteLine("> Word Search Library version: {0}", GlasswallWordSearch.GwWordSearchVersion());

                    string xmlConfig = File.ReadAllText(xmlConfigPath);
                    string homoglyphs = File.ReadAllText(homoglyphsPath);

                    foreach (string path in Directory.EnumerateFiles(inputDirectory, "*", SearchOption.AllDirectories))
                    {
                        writer.WriteLine("> Processing file: {0}", path);
                        string inputDirectoryPath = path.Substring(inputDirectory.Length + 1);
                        string directory = Path.Combine(outputDirectory, inputDirectoryPath);
                        Directory.CreateDirectory(directory);
                        processFile(path, directory, homoglyphs, xmlConfig);
                    }
                }
            }

            return;
        }
        static void WriteAllBytes(string path, byte[] data)
        {
            if (data == null)
            {
                File.Create(path);
            }
            else
            {
                File.WriteAllBytes(path, data);
            }
        }
        public static void processFile(string inputFile, string outputDirectory, string homoglyphs, string xmlConfig)
        {

            using (FileStream fileStream = new FileStream(Path.Combine(outputDirectory, Path.GetFileName(inputFile) + ".log"), FileMode.OpenOrCreate, FileAccess.Write))
            {
                using (StreamWriter writer = new StreamWriter(fileStream))
                {
                    // Word Search
                    writer.WriteLine(">> Run Word Search");
                    byte[] inputFileBuffer = File.ReadAllBytes(inputFile);
                    byte[] outputBuffer, outputReportBuffer;
                    GlasswallWordSearch.WordSearchStatus status = GlasswallWordSearch.GwWordSearch(inputFileBuffer, out outputBuffer, out outputReportBuffer, homoglyphs, xmlConfig);
                    writer.WriteLine("Status is: {0}", status);

                    if (outputBuffer != null)
                    {
                        WriteAllBytes(Path.Combine(outputDirectory, Path.GetFileName(inputFile)), outputBuffer);
                    }

                    if (outputReportBuffer != null)
                    {
                        WriteAllBytes(Path.Combine(outputDirectory, Path.GetFileName(inputFile)) + ".xml", outputReportBuffer);
                    }
                }
            }
        }
    }
}

Java​

package com.glasswallsolutions;

import java.lang.System;
import java.io.*;
import com.glasswallsolutions.*;
import java.nio.file.Paths;

public class MainTest {

	public static byte[] readAllBytes(InputStream inputStream) throws IOException
	{
		final int bufLen = 4 * 0x400; // 4KB
		byte[] buf = new byte[bufLen];
		int readLen;

		try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
			while ((readLen = inputStream.read(buf, 0, bufLen)) != -1)
				outputStream.write(buf, 0, readLen);

			return outputStream.toByteArray();
		}
	}

	public static void main(String[] args) throws Exception {
		if (args.length != 4)
		{
			System.out.println("Usage: <Input Directory> <Output Directory> <Homoglyphs File> <Config XML>");
			System.exit(-1);
		}

		File inputDirectory = new File(args[0]);
		File outputDirectory = new File(args[1]);
		outputDirectory.delete();
		outputDirectory.mkdir();
		String homoglyphsFile = args[2];
		String configXmlFile = args[3];

		String homoglyphs = null;
		String configXML = null;

		GlasswallWordSearch glasswallWordSearch = new GlasswallWordSearch();

		try(FileInputStream homoglyphsInputStream = new FileInputStream(homoglyphsFile))
		{
			homoglyphs = new String(readAllBytes(homoglyphsInputStream));
		}

		try(FileInputStream configXmlInputStream = new FileInputStream(configXmlFile))
		{
			configXML = new String(readAllBytes(configXmlInputStream));
		}

		System.out.println("Word Search version: " + glasswallWordSearch.version());

		for (File inputFile : inputDirectory.listFiles())
		{
			try
			{
				System.out.println("Processing file: " + inputFile.getAbsolutePath());

				File fileOutputDirectory = new File(Paths.get(outputDirectory.getAbsolutePath(), inputFile.getName()).toString());
				fileOutputDirectory.mkdir();
				String fileOutputPath = Paths.get(fileOutputDirectory.getAbsolutePath(), inputFile.getName()).toString();

				try(FileInputStream inputStream = new FileInputStream(inputFile))
				{
					byte[] fileData = readAllBytes(inputStream);

					GlasswallWordSearchResult result = glasswallWordSearch.wordSearch(fileData, homoglyphs, configXML);

					System.out.println("Status: " + result.success);

					if (result.outputDocument != null)
					{
						try(FileOutputStream fileOutputStream = new FileOutputStream(fileOutputPath))
						{
							fileOutputStream.write(result.outputDocument);
						}
					}

					if (result.report != null)
					{
						try(FileOutputStream fileOutputStream = new FileOutputStream(fileOutputPath + ".xml"))
						{
							fileOutputStream.write(result.report.getBytes());
						}
					}
				}
			}
			catch(Exception ex)
			{
				System.err.println("Exception occurred: " + ex.getMessage());
				ex.printStackTrace(System.err);

			}
		}
	}
}

Python​

Để xem thêm ví dụ, hãy xem Python Word Search & Redaction

JavaScript​

import fs from 'fs';
import path from 'path';
import { GlasswallWordSearch, GlasswallWordSearchNative, WordSearchResult, WordSearchStatus } from '../index'

let main = function()
{
    const args = process.argv;

    if (args.length === 7)
    {
        let wordSearchDllPath = path.resolve(args[2]);
        let inputDirectory    = path.resolve(args[3]);
        let outputDirectory   = path.resolve(args[4]);
        let homoglyphsPath    = path.resolve(args[5]);
        let configXmlPath     = path.resolve(args[6]);

        let handler = new GlasswallWordSearchNative(wordSearchDllPath, { enableLogging: true});
        let glasswallWordSearch = new GlasswallWordSearch(handler);
        console.log("Glasswall Word Search version: " + glasswallWordSearch.version())

        if (!fs.existsSync(inputDirectory))
        {
            console.log('Input Directory does not exist: ' + inputDirectory);
            process.exit(-1);
        }

        if (!fs.existsSync(homoglyphsPath))
        {
            console.log('Homoglyphs file does not exist: ' + homoglyphsPath);
            process.exit(-1);
        }

        if (!fs.existsSync(configXmlPath))
        {
            console.log('Config XML file does not exist: ' + configXmlPath);
            process.exit(-1);
        }

        let homoglyphs = fs.readFileSync(homoglyphsPath, 'utf8');
        let configXml  = fs.readFileSync(configXmlPath , 'utf8');

        fs.mkdirSync(outputDirectory, {recursive: true});

        fs.readdirSync(inputDirectory).forEach(file => {
            try
            {
                let fullFilePath = path.join(inputDirectory, file);

                if (fs.statSync(fullFilePath).isFile())
                {
                    console.log('Processing file: ' + fullFilePath);
                    let outputFileDirectory = path.join(outputDirectory, file);
                    fs.mkdirSync(outputFileDirectory);
                    let inputBuffer = fs.readFileSync(fullFilePath);
                    let wordSearchResult = glasswallWordSearch.wordSearch(inputBuffer, homoglyphs, configXml);
                    console.log("Status: " + wordSearchResult.status);

                    if (wordSearchResult.outputBuffer != undefined && wordSearchResult.outputBuffer != null)
                    {
                        fs.writeFileSync(path.join(outputFileDirectory, file), wordSearchResult.outputBuffer);
                    }

                    if (wordSearchResult.analysisXmlReport != undefined && wordSearchResult.analysisXmlReport != null)
                    {
                        fs.writeFileSync(path.join(outputFileDirectory, file + ".xml"), wordSearchResult.analysisXmlReport);
                    }
                }
            }
            catch(error)
            {
                console.log("Exception occurred: " + error);
                console.trace(error);
            }

        })
    }
    else
    {
        console.log("Usage: Application <Library File> <Input Directory> <Output Directory> <Homoglyphs File> <Config XML>");
        process.exit(-1);
    }
}

if (require.main === module){
    main();
}