સુરક્ષિત બ્રાઉઝર એક્સ્ટેંશન લખવું

સામાન્ય "ક્લાયન્ટ-સર્વર" આર્કિટેક્ચરથી વિપરીત, વિકેન્દ્રિત એપ્લિકેશનો લાક્ષણિકતા ધરાવે છે:

• યુઝર લોગીન અને પાસવર્ડ સાથે ડેટાબેઝ સ્ટોર કરવાની જરૂર નથી. ઍક્સેસ માહિતી ફક્ત વપરાશકર્તાઓ દ્વારા જ સંગ્રહિત કરવામાં આવે છે, અને તેમની અધિકૃતતાની પુષ્ટિ પ્રોટોકોલ સ્તરે થાય છે.
• સર્વરનો ઉપયોગ કરવાની જરૂર નથી. એપ્લિકેશન લોજિક બ્લોકચેન નેટવર્ક પર એક્ઝિક્યુટ કરી શકાય છે, જ્યાં જરૂરી માત્રામાં ડેટા સ્ટોર કરવાનું શક્ય છે.

વપરાશકર્તા કી માટે 2 પ્રમાણમાં સલામત સ્ટોરેજ છે - હાર્ડવેર વોલેટ્સ અને બ્રાઉઝર એક્સ્ટેન્શન્સ. હાર્ડવેર વોલેટ્સ મોટાભાગે અત્યંત સુરક્ષિત છે, પરંતુ વાપરવા માટે મુશ્કેલ છે અને મફતથી દૂર છે, પરંતુ બ્રાઉઝર એક્સ્ટેન્શન્સ સલામતી અને ઉપયોગમાં સરળતાનું સંપૂર્ણ સંયોજન છે, અને અંતિમ વપરાશકર્તાઓ માટે સંપૂર્ણપણે મફત પણ હોઈ શકે છે.

આ બધાને ધ્યાનમાં રાખીને, અમે વ્યવહારો અને હસ્તાક્ષર સાથે કામ કરવા માટે એક સરળ API પ્રદાન કરીને વિકેન્દ્રિત એપ્લિકેશનના વિકાસને સરળ બનાવે તેવું સૌથી સુરક્ષિત એક્સ્ટેંશન બનાવવા માગીએ છીએ.
અમે તમને નીચે આ અનુભવ વિશે જણાવીશું.

લેખમાં કોડ ઉદાહરણો અને સ્ક્રીનશૉટ્સ સાથે, બ્રાઉઝર એક્સ્ટેંશન કેવી રીતે લખવું તેના પર પગલું-દર-પગલાં સૂચનો હશે. તમે બધા કોડ શોધી શકો છો ભંડાર. દરેક પ્રતિબદ્ધતા તાર્કિક રીતે આ લેખના વિભાગને અનુરૂપ છે.

બ્રાઉઝર એક્સ્ટેન્શન્સનો સંક્ષિપ્ત ઇતિહાસ

બ્રાઉઝર એક્સ્ટેંશન લાંબા સમયથી આસપાસ છે. તેઓ 1999માં ઈન્ટરનેટ એક્સપ્લોરરમાં, 2004માં ફાયરફોક્સમાં દેખાયા હતા. જો કે, ખૂબ લાંબા સમયથી એક્સ્ટેંશન માટે કોઈ એક ધોરણ નહોતું.

અમે કહી શકીએ કે તે Google Chrome ના ચોથા સંસ્કરણમાં એક્સ્ટેંશન સાથે દેખાયો. અલબત્ત, ત્યારે કોઈ સ્પષ્ટીકરણ નહોતું, પરંતુ તે ક્રોમ API હતું જે તેનો આધાર બન્યો: મોટાભાગના બ્રાઉઝર માર્કેટ પર વિજય મેળવ્યો અને બિલ્ટ-ઇન એપ્લિકેશન સ્ટોર હોવાને કારણે, ક્રોમે વાસ્તવમાં બ્રાઉઝર એક્સ્ટેંશન માટે પ્રમાણભૂત સેટ કર્યું.

મોઝિલાનું પોતાનું સ્ટાન્ડર્ડ હતું, પરંતુ ક્રોમ એક્સટેન્શનની લોકપ્રિયતા જોઈને કંપનીએ સુસંગત API બનાવવાનું નક્કી કર્યું. 2015 માં, મોઝિલાની પહેલ પર, ક્રોસ-બ્રાઉઝર એક્સ્ટેંશન વિશિષ્ટતાઓ પર કામ કરવા માટે વર્લ્ડ વાઇડ વેબ કન્સોર્ટિયમ (W3C) ની અંદર એક વિશેષ જૂથ બનાવવામાં આવ્યું હતું.

Chrome માટે હાલના API એક્સ્ટેંશનને આધાર તરીકે લેવામાં આવ્યા હતા. માઇક્રોસોફ્ટના સમર્થન સાથે કાર્ય હાથ ધરવામાં આવ્યું હતું (ગૂગલે ધોરણના વિકાસમાં ભાગ લેવાનો ઇનકાર કર્યો હતો), અને પરિણામે એક ડ્રાફ્ટ દેખાયો. સ્પષ્ટીકરણો.

ઔપચારિક રીતે, સ્પષ્ટીકરણ એજ, ફાયરફોક્સ અને ઓપેરા દ્વારા સમર્થિત છે (નોંધ કરો કે ક્રોમ આ સૂચિમાં નથી). પરંતુ હકીકતમાં, પ્રમાણભૂત મોટાભાગે ક્રોમ સાથે સુસંગત છે, કારણ કે તે વાસ્તવમાં તેના એક્સ્ટેંશનના આધારે લખાયેલું છે. તમે WebExtensions API વિશે વધુ વાંચી શકો છો અહીં.

વિસ્તરણ માળખું

એક્સ્ટેંશન માટે જરૂરી છે તે એકમાત્ર ફાઇલ મેનિફેસ્ટ છે (manifest.json). તે વિસ્તરણ માટે "પ્રવેશ બિંદુ" પણ છે.

મેનિફેસ્ટ

સ્પષ્ટીકરણ મુજબ, મેનિફેસ્ટ ફાઇલ માન્ય JSON ફાઇલ છે. કયા બ્રાઉઝરમાં જોઈ શકાય છે તેમાં કઈ કીઝ સપોર્ટેડ છે તેની માહિતી સાથે મેનિફેસ્ટ કીનું સંપૂર્ણ વર્ણન અહીં.

સ્પષ્ટીકરણમાં ન હોય તેવી કીને અવગણવામાં આવી શકે છે (Chrome અને Firefox બંને ભૂલોની જાણ કરે છે, પરંતુ એક્સ્ટેંશન કામ કરવાનું ચાલુ રાખે છે).

અને હું કેટલાક મુદ્દાઓ પર ધ્યાન દોરવા માંગુ છું.

1. પૃષ્ઠભૂમિ — એક ઑબ્જેક્ટ જેમાં નીચેના ક્ષેત્રો શામેલ છે:
   1. સ્ક્રિપ્ટ્સ — સ્ક્રિપ્ટ્સની શ્રેણી કે જે પૃષ્ઠભૂમિ સંદર્ભમાં ચલાવવામાં આવશે (આપણે આ વિશે થોડી વાર પછી વાત કરીશું);
   2. પૃષ્ઠ - સ્ક્રિપ્ટ્સને બદલે કે જે ખાલી પૃષ્ઠમાં ચલાવવામાં આવશે, તમે સામગ્રી સાથે html નો ઉલ્લેખ કરી શકો છો. આ કિસ્સામાં, સ્ક્રિપ્ટ ફીલ્ડને અવગણવામાં આવશે, અને સ્ક્રિપ્ટ્સને સામગ્રી પૃષ્ઠમાં દાખલ કરવાની જરૂર પડશે;
   3. ચાલુ — દ્વિસંગી ધ્વજ, જો ઉલ્લેખિત ન હોય, તો બ્રાઉઝર પૃષ્ઠભૂમિ પ્રક્રિયાને "મારી નાખશે" જ્યારે તે માને છે કે તે કંઈ કરી રહ્યું નથી, અને જો જરૂરી હોય તો તેને પુનઃપ્રારંભ કરશે. નહિંતર, જ્યારે બ્રાઉઝર બંધ હોય ત્યારે જ પૃષ્ઠને અનલોડ કરવામાં આવશે. ફાયરફોક્સમાં સપોર્ટેડ નથી.
2. સામગ્રી_સ્ક્રિપ્ટ્સ — ઑબ્જેક્ટ્સની એરે જે તમને વિવિધ વેબ પૃષ્ઠો પર વિવિધ સ્ક્રિપ્ટો લોડ કરવાની મંજૂરી આપે છે. દરેક ઑબ્જેક્ટમાં નીચેના મહત્વપૂર્ણ ક્ષેત્રો શામેલ છે:
   1. મેચો - પેટર્ન url, જે નક્કી કરે છે કે કોઈ ચોક્કસ સામગ્રી સ્ક્રિપ્ટનો સમાવેશ કરવામાં આવશે કે નહીં.
   2. js — સ્ક્રિપ્ટ્સની સૂચિ કે જે આ મેચમાં લોડ કરવામાં આવશે;
   3. બાકાત_મેચ - ક્ષેત્રમાંથી બાકાત match આ ફીલ્ડ સાથે મેળ ખાતા URL.
3. પૃષ્ઠ_ક્રિયા - વાસ્તવમાં એક ઑબ્જેક્ટ છે જે બ્રાઉઝરમાં એડ્રેસ બારની બાજુમાં પ્રદર્શિત થતા આઇકન અને તેની સાથે ક્રિયાપ્રતિક્રિયા માટે જવાબદાર છે. તે તમને પોપઅપ વિન્ડો દર્શાવવા માટે પણ પરવાનગી આપે છે, જે તમારા પોતાના HTML, CSS અને JS નો ઉપયોગ કરીને વ્યાખ્યાયિત કરવામાં આવે છે.
   1. ડિફોલ્ટ_પોપઅપ - પોપઅપ ઈન્ટરફેસ સાથે HTML ફાઈલનો પાથ, CSS અને JS સમાવી શકે છે.
4. પરવાનગીઓ - એક્સ્ટેંશન અધિકારોનું સંચાલન કરવા માટે એક એરે. ત્યાં 3 પ્રકારના અધિકારો છે, જેનું વિગતવાર વર્ણન કરવામાં આવ્યું છે અહીં
5. વેબ_ઍક્સેસિબલ_સંસાધનો — એક્સ્ટેંશન સંસાધનો કે જે વેબ પૃષ્ઠ વિનંતી કરી શકે છે, ઉદાહરણ તરીકે, છબીઓ, JS, CSS, HTML ફાઇલો.
6. બાહ્ય રીતે_કનેક્ટેબલ — અહીં તમે અન્ય એક્સ્ટેંશન અને વેબ પેજના ડોમેન્સ કે જેમાંથી તમે કનેક્ટ કરી શકો છો તેના ID ને સ્પષ્ટપણે સ્પષ્ટ કરી શકો છો. ડોમેન બીજા સ્તર અથવા ઉચ્ચ હોઈ શકે છે. ફાયરફોક્સમાં કામ કરતું નથી.

એક્ઝેક્યુશન સંદર્ભ

એક્સ્ટેંશનમાં ત્રણ કોડ એક્ઝેક્યુશન સંદર્ભો છે, એટલે કે, એપ્લિકેશનમાં બ્રાઉઝર API ની ઍક્સેસના વિવિધ સ્તરો સાથે ત્રણ ભાગોનો સમાવેશ થાય છે.

વિસ્તરણ સંદર્ભ

મોટાભાગના API અહીં ઉપલબ્ધ છે. આ સંદર્ભમાં તેઓ "જીવંત" છે:

1. પૃષ્ઠભૂમિ પૃષ્ઠ - એક્સ્ટેંશનનો "બેકએન્ડ" ભાગ. ફાઇલ "બેકગ્રાઉન્ડ" કીનો ઉપયોગ કરીને મેનિફેસ્ટમાં ઉલ્લેખિત છે.
2. પોપઅપ પૃષ્ઠ - જ્યારે તમે એક્સ્ટેંશન આયકન પર ક્લિક કરો છો ત્યારે એક પોપઅપ પેજ દેખાય છે. જાહેરનામામાં browser_action -> default_popup.
3. કસ્ટમ પૃષ્ઠ - એક્સ્ટેંશન પૃષ્ઠ, દૃશ્યના અલગ ટેબમાં "જીવંત". chrome-extension://<id_расширения>/customPage.html.

આ સંદર્ભ બ્રાઉઝર વિન્ડો અને ટૅબ્સથી સ્વતંત્ર રીતે અસ્તિત્વમાં છે. પૃષ્ઠભૂમિ પૃષ્ઠ એક નકલમાં અસ્તિત્વમાં છે અને હંમેશા કાર્ય કરે છે (અપવાદ એ ઇવેન્ટ પૃષ્ઠ છે, જ્યારે પૃષ્ઠભૂમિ સ્ક્રિપ્ટ ઇવેન્ટ દ્વારા લોન્ચ કરવામાં આવે છે અને તેના અમલ પછી "મૃત્યુ પામે છે). પોપઅપ પૃષ્ઠ જ્યારે પોપઅપ વિન્ડો ખુલ્લી હોય ત્યારે અસ્તિત્વમાં છે, અને કસ્ટમ પૃષ્ઠ — જ્યારે તેની સાથેની ટેબ ખુલ્લી હોય. આ સંદર્ભમાંથી અન્ય ટેબ્સ અને તેમના સમાવિષ્ટોની કોઈ ઍક્સેસ નથી.

સામગ્રી સ્ક્રિપ્ટ સંદર્ભ

સામગ્રી સ્ક્રિપ્ટ ફાઇલ દરેક બ્રાઉઝર ટેબ સાથે લોન્ચ કરવામાં આવે છે. તેની પાસે એક્સ્ટેંશનના API ના ભાગ અને વેબ પૃષ્ઠના DOM ટ્રીની ઍક્સેસ છે. તે સામગ્રી સ્ક્રિપ્ટો છે જે પૃષ્ઠ સાથે ક્રિયાપ્રતિક્રિયા માટે જવાબદાર છે. એક્સ્ટેંશન્સ કે જે DOM ટ્રીને મેનિપ્યુલેટ કરે છે તે સામગ્રી સ્ક્રિપ્ટ્સમાં આ કરે છે - ઉદાહરણ તરીકે, એડ બ્લોકર્સ અથવા અનુવાદકો. ઉપરાંત, સામગ્રી સ્ક્રિપ્ટ પ્રમાણભૂત દ્વારા પૃષ્ઠ સાથે વાતચીત કરી શકે છે postMessage.

વેબ પૃષ્ઠ સંદર્ભ

આ પોતે જ વાસ્તવિક વેબ પેજ છે. તેને એક્સ્ટેંશન સાથે કોઈ લેવાદેવા નથી અને તેની પાસે ત્યાં ઍક્સેસ નથી, સિવાય કે આ પૃષ્ઠનું ડોમેન મેનિફેસ્ટમાં સ્પષ્ટપણે દર્શાવવામાં આવ્યું નથી (નીચે આના પર વધુ).

સંદેશ વિનિમય

એપ્લિકેશનના વિવિધ ભાગોએ એકબીજા સાથે સંદેશાઓની આપલે કરવી આવશ્યક છે. આ માટે એક API છે runtime.sendMessage સંદેશ મોકલવા માટે background и tabs.sendMessage પૃષ્ઠ પર સંદેશ મોકલવા માટે (સામગ્રી સ્ક્રિપ્ટ, પોપઅપ અથવા વેબ પૃષ્ઠ જો ઉપલબ્ધ હોય તો externally_connectable). Chrome API ને ઍક્સેસ કરતી વખતે નીચે એક ઉદાહરણ છે.

// Сообщением может быть любой JSON сериализуемый объект
const msg = {a: 'foo', b: 'bar'};

// extensionId можно не указывать, если мы хотим послать сообщение 'своему' расширению (из ui или контент скрипта)
chrome.runtime.sendMessage(extensionId, msg);

// Так выглядит обработчик
chrome.runtime.onMessage.addListener((msg) => console.log(msg))

// Можно слать сообщения вкладкам зная их id
chrome.tabs.sendMessage(tabId, msg)

// Получить к вкладкам и их id можно, например, вот так
chrome.tabs.query(
    {currentWindow: true, active : true},
    function(tabArray){
      tabArray.forEach(tab => console.log(tab.id))
    }
)

સંપૂર્ણ સંચાર માટે, તમે મારફતે જોડાણો બનાવી શકો છો runtime.connect. જવાબમાં અમે પ્રાપ્ત કરીશું runtime.Port, જેના પર, જ્યારે તે ખુલ્લું હોય, ત્યારે તમે ગમે તેટલા સંદેશાઓ મોકલી શકો છો. ક્લાયંટ બાજુ પર, ઉદાહરણ તરીકે, contentscript, તે આના જેવું દેખાય છે:

// Опять же extensionId можно не указывать при коммуникации внутри одного расширения. Подключение можно именовать
const port = chrome.runtime.connect({name: "knockknock"});
port.postMessage({joke: "Knock knock"});
port.onMessage.addListener(function(msg) {
    if (msg.question === "Who's there?")
        port.postMessage({answer: "Madame"});
    else if (msg.question === "Madame who?")
        port.postMessage({answer: "Madame... Bovary"});

સર્વર અથવા પૃષ્ઠભૂમિ:

// Обработчик для подключения 'своих' вкладок. Контент скриптов, popup или страниц расширения
chrome.runtime.onConnect.addListener(function(port) {
    console.assert(port.name === "knockknock");
    port.onMessage.addListener(function(msg) {
        if (msg.joke === "Knock knock")
            port.postMessage({question: "Who's there?"});
        else if (msg.answer === "Madame")
            port.postMessage({question: "Madame who?"});
        else if (msg.answer === "Madame... Bovary")
            port.postMessage({question: "I don't get it."});
    });
});

// Обработчик для подключения внешних вкладок. Других расширений или веб страниц, которым разрешен доступ в манифесте
chrome.runtime.onConnectExternal.addListener(function(port) {
    ...
});

એક પ્રસંગ પણ છે onDisconnect અને પદ્ધતિ disconnect.

એપ્લિકેશન ડાયાગ્રામ

ચાલો એક બ્રાઉઝર એક્સ્ટેંશન બનાવીએ જે ખાનગી કીને સંગ્રહિત કરે છે, સાર્વજનિક માહિતીની ઍક્સેસ પ્રદાન કરે છે (સરનામું, સાર્વજનિક કી પૃષ્ઠ સાથે વાતચીત કરે છે અને તૃતીય-પક્ષ એપ્લિકેશનોને વ્યવહારો માટે સહી માટે વિનંતી કરવાની મંજૂરી આપે છે.

એપ્લિકેશન વિકાસ

અમારી એપ્લિકેશન બંનેએ વપરાશકર્તા સાથે ક્રિયાપ્રતિક્રિયા કરવી જોઈએ અને કૉલ પદ્ધતિઓ (ઉદાહરણ તરીકે, વ્યવહારો પર હસ્તાક્ષર કરવા માટે) માટે API સાથે પૃષ્ઠ પ્રદાન કરવું જોઈએ. માત્ર એક સાથે કરો contentscript કામ કરશે નહીં, કારણ કે તેની પાસે ફક્ત DOM નો જ એક્સેસ છે, પરંતુ પેજના JS માટે નહીં. દ્વારા કનેક્ટ કરો runtime.connect અમે કરી શકતા નથી, કારણ કે API બધા ડોમેન્સ પર જરૂરી છે અને મેનિફેસ્ટમાં માત્ર ચોક્કસ જ ઉલ્લેખિત કરી શકાય છે. પરિણામે, ડાયાગ્રામ આના જેવો દેખાશે:

બીજી સ્ક્રિપ્ટ હશે - inpage, જે અમે પૃષ્ઠમાં દાખલ કરીશું. તે તેના સંદર્ભમાં ચાલશે અને એક્સ્ટેંશન સાથે કામ કરવા માટે API પ્રદાન કરશે.

શરૂઆત

બધા બ્રાઉઝર એક્સ્ટેંશન કોડ પર ઉપલબ્ધ છે GitHub. વર્ણન દરમિયાન કમિટ્સની લિંક્સ હશે.

ચાલો મેનિફેસ્ટો સાથે પ્રારંભ કરીએ:

{
  // Имя и описание, версия. Все это будет видно в браузере в chrome://extensions/?id=<id расширения>
  "name": "Signer",
  "description": "Extension demo",
  "version": "0.0.1",
  "manifest_version": 2,

  // Скрипты, которые будут исполнятся в background, их может быть несколько
  "background": {
    "scripts": ["background.js"]
  },

  // Какой html использовать для popup
  "browser_action": {
    "default_title": "My Extension",
    "default_popup": "popup.html"
  },

  // Контент скрипты.
  // У нас один объект: для всех url начинающихся с http или https мы запускаем
  // contenscript context со скриптом contentscript.js. Запускать сразу по получении документа для всех фреймов
  "content_scripts": [
    {
      "matches": [
        "http://*/*",
        "https://*/*"
      ],
      "js": [
        "contentscript.js"
      ],
      "run_at": "document_start",
      "all_frames": true
    }
  ],
  // Разрешен доступ к localStorage и idle api
  "permissions": [
    "storage",
    // "unlimitedStorage",
    //"clipboardWrite",
    "idle"
    //"activeTab",
    //"webRequest",
    //"notifications",
    //"tabs"
  ],
  // Здесь указываются ресурсы, к которым будет иметь доступ веб страница. Тоесть их можно будет запрашивать fetche'м или просто xhr
  "web_accessible_resources": ["inpage.js"]
}

ખાલી background.js, popup.js, inpage.js અને contentscript.js બનાવો. અમે popup.html ઉમેરીએ છીએ - અને અમારી એપ્લિકેશન પહેલેથી જ Google Chrome માં લોડ થઈ શકે છે અને ખાતરી કરો કે તે કાર્ય કરે છે.

આને ચકાસવા માટે, તમે કોડ લઈ શકો છો અહીંથી. અમે જે કર્યું તે ઉપરાંત, લિંક વેબપેકનો ઉપયોગ કરીને પ્રોજેક્ટની એસેમ્બલીને ગોઠવે છે. બ્રાઉઝરમાં એપ્લિકેશન ઉમેરવા માટે, chrome://extensions માં તમારે લોડ અનપેક્ડ અને અનુરૂપ એક્સ્ટેંશન સાથે ફોલ્ડર પસંદ કરવાની જરૂર છે - અમારા કિસ્સામાં જી.

હવે અમારું એક્સ્ટેંશન ઇન્સ્ટોલ થઈ ગયું છે અને કામ કરી રહ્યું છે. તમે નીચે પ્રમાણે વિવિધ સંદર્ભો માટે વિકાસકર્તા સાધનો ચલાવી શકો છો:

પોપઅપ ->

સામગ્રી સ્ક્રિપ્ટ કન્સોલની ઍક્સેસ તે પૃષ્ઠના જ કન્સોલ દ્વારા હાથ ધરવામાં આવે છે જેના પર તે લોન્ચ કરવામાં આવ્યું છે.

સંદેશ વિનિમય

તેથી, આપણે બે સંચાર ચેનલો સ્થાપિત કરવાની જરૂર છે: inpage <-> પૃષ્ઠભૂમિ અને પોપઅપ <-> પૃષ્ઠભૂમિ. તમે, અલબત્ત, ફક્ત પોર્ટ પર સંદેશા મોકલી શકો છો અને તમારા પોતાના પ્રોટોકોલની શોધ કરી શકો છો, પરંતુ હું મેટામાસ્ક ઓપન સોર્સ પ્રોજેક્ટમાં જોયેલા અભિગમને પસંદ કરું છું.

આ Ethereum નેટવર્ક સાથે કામ કરવા માટે એક બ્રાઉઝર એક્સ્ટેંશન છે. તેમાં, એપ્લિકેશનના વિવિધ ભાગો dnode લાઇબ્રેરીનો ઉપયોગ કરીને RPC દ્વારા વાતચીત કરે છે. જો તમે તેને પરિવહન તરીકે નોડજ સ્ટ્રીમ સાથે પ્રદાન કરો છો તો તે તમને ખૂબ જ ઝડપથી અને સગવડતાપૂર્વક એક્સચેન્જનું આયોજન કરવાની મંજૂરી આપે છે (એટલે ​​કે ઑબ્જેક્ટ જે સમાન ઇન્ટરફેસને લાગુ કરે છે):

import Dnode from "dnode/browser";

// В этом примере условимся что клиент удаленно вызывает функции на сервере, хотя ничего нам не мешает сделать это двунаправленным

// Cервер
// API, которое мы хотим предоставить
const dnode = Dnode({
    hello: (cb) => cb(null, "world")
})
// Транспорт, поверх которого будет работать dnode. Любой nodejs стрим. В браузере есть бибилиотека 'readable-stream'
connectionStream.pipe(dnode).pipe(connectionStream)

// Клиент
const dnodeClient = Dnode() // Вызов без агрумента значит что мы не предоставляем API на другой стороне

// Выведет в консоль world
dnodeClient.once('remote', remote => {
    remote.hello(((err, value) => console.log(value)))
})

હવે આપણે એપ્લિકેશન ક્લાસ બનાવીશું. તે પોપઅપ અને વેબ પેજ માટે API ઓબ્જેક્ટ બનાવશે અને તેમના માટે ડીનોડ બનાવશે:

import Dnode from 'dnode/browser';

export class SignerApp {

    // Возвращает объект API для ui
    popupApi(){
        return {
            hello: cb => cb(null, 'world')
        }
    }

    // Возвращает объет API для страницы
    pageApi(){
        return {
            hello: cb => cb(null, 'world')
        }
    }

    // Подключает popup ui
    connectPopup(connectionStream){
        const api = this.popupApi();
        const dnode = Dnode(api);

        connectionStream.pipe(dnode).pipe(connectionStream);

        dnode.on('remote', (remote) => {
            console.log(remote)
        })
    }

    // Подключает страницу
    connectPage(connectionStream, origin){
        const api = this.popupApi();
        const dnode = Dnode(api);

        connectionStream.pipe(dnode).pipe(connectionStream);

        dnode.on('remote', (remote) => {
            console.log(origin);
            console.log(remote)
        })
    }
}

અહીં અને નીચે, વૈશ્વિક ક્રોમ ઑબ્જેક્ટને બદલે, અમે એક્સટેન્શન એપીઆઈનો ઉપયોગ કરીએ છીએ, જે Google ના બ્રાઉઝરમાં ક્રોમ અને અન્યમાં બ્રાઉઝરને ઍક્સેસ કરે છે. આ ક્રોસ-બ્રાઉઝર સુસંગતતા માટે કરવામાં આવે છે, પરંતુ આ લેખના હેતુઓ માટે કોઈ ફક્ત 'chrome.runtime.connect' નો ઉપયોગ કરી શકે છે.

ચાલો પૃષ્ઠભૂમિ સ્ક્રિપ્ટમાં એપ્લિકેશન દાખલો બનાવીએ:

import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import {SignerApp} from "./SignerApp";

const app = new SignerApp();

// onConnect срабатывает при подключении 'процессов' (contentscript, popup, или страница расширения)
extensionApi.runtime.onConnect.addListener(connectRemote);

function connectRemote(remotePort) {
    const processName = remotePort.name;
    const portStream = new PortStream(remotePort);
    // При установке соединения можно указывать имя, по этому имени мы и оппределяем кто к нам подлючился, контентскрипт или ui
    if (processName === 'contentscript'){
        const origin = remotePort.sender.url
        app.connectPage(portStream, origin)
    }else{
        app.connectPopup(portStream)
    }
}

કારણ કે dnode સ્ટ્રીમ્સ સાથે કામ કરે છે, અને અમને પોર્ટ પ્રાપ્ત થાય છે, એડેપ્ટર વર્ગની જરૂર છે. તે વાંચી શકાય તેવી-સ્ટ્રીમ લાઇબ્રેરીનો ઉપયોગ કરીને બનાવવામાં આવે છે, જે બ્રાઉઝરમાં નોડજ સ્ટ્રીમ્સ લાગુ કરે છે:

import {Duplex} from 'readable-stream';

export class PortStream extends Duplex{
    constructor(port){
        super({objectMode: true});
        this._port = port;
        port.onMessage.addListener(this._onMessage.bind(this));
        port.onDisconnect.addListener(this._onDisconnect.bind(this))
    }

    _onMessage(msg) {
        if (Buffer.isBuffer(msg)) {
            delete msg._isBuffer;
            const data = new Buffer(msg);
            this.push(data)
        } else {
            this.push(msg)
        }
    }

    _onDisconnect() {
        this.destroy()
    }

    _read(){}

    _write(msg, encoding, cb) {
        try {
            if (Buffer.isBuffer(msg)) {
                const data = msg.toJSON();
                data._isBuffer = true;
                this._port.postMessage(data)
            } else {
                this._port.postMessage(msg)
            }
        } catch (err) {
            return cb(new Error('PortStream - disconnected'))
        }
        cb()
    }
}

હવે ચાલો UI માં કનેક્શન બનાવીએ:

import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import Dnode from 'dnode/browser';

const DEV_MODE = process.env.NODE_ENV !== 'production';

setupUi().catch(console.error);

async function setupUi(){
    // Также, как и в классе приложения создаем порт, оборачиваем в stream, делаем  dnode
    const backgroundPort = extensionApi.runtime.connect({name: 'popup'});
    const connectionStream = new PortStream(backgroundPort);

    const dnode = Dnode();

    connectionStream.pipe(dnode).pipe(connectionStream);

    const background = await new Promise(resolve => {
        dnode.once('remote', api => {
            resolve(api)
        })
    });

    // Делаем объект API доступным из консоли
    if (DEV_MODE){
        global.background = background;
    }
}

પછી અમે સામગ્રી સ્ક્રિપ્ટમાં કનેક્શન બનાવીએ છીએ:

import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import PostMessageStream from 'post-message-stream';

setupConnection();
injectScript();

function setupConnection(){
    const backgroundPort = extensionApi.runtime.connect({name: 'contentscript'});
    const backgroundStream = new PortStream(backgroundPort);

    const pageStream = new PostMessageStream({
        name: 'content',
        target: 'page',
    });

    pageStream.pipe(backgroundStream).pipe(pageStream);
}

function injectScript(){
    try {
        // inject in-page script
        let script = document.createElement('script');
        script.src = extensionApi.extension.getURL('inpage.js');
        const container = document.head || document.documentElement;
        container.insertBefore(script, container.children[0]);
        script.onload = () => script.remove();
    } catch (e) {
        console.error('Injection failed.', e);
    }
}

અમને API ની જરૂર સામગ્રી સ્ક્રિપ્ટમાં નથી, પરંતુ સીધા પૃષ્ઠ પર હોવાથી, અમે બે વસ્તુઓ કરીએ છીએ:

1. અમે બે પ્રવાહો બનાવીએ છીએ. એક - પૃષ્ઠ તરફ, પોસ્ટમેસેજની ટોચ પર. આ માટે અમે આનો ઉપયોગ કરીએ છીએ આ પેકેજ મેટામાસ્કના નિર્માતાઓ તરફથી. બીજી સ્ટ્રીમ પોર્ટ પરથી મળેલ પૃષ્ઠભૂમિ પર છે runtime.connect. ચાલો તેમને ખરીદીએ. હવે પૃષ્ઠ પૃષ્ઠભૂમિ પર એક સ્ટ્રીમ હશે.
2. સ્ક્રિપ્ટને DOM માં દાખલ કરો. સ્ક્રિપ્ટ ડાઉનલોડ કરો (મેનિફેસ્ટમાં તેની ઍક્સેસની મંજૂરી હતી) અને ટેગ બનાવો script તેની અંદરની સામગ્રી સાથે:

import PostMessageStream from 'post-message-stream';
import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";

setupConnection();
injectScript();

function setupConnection(){
    // Стрим к бекграунду
    const backgroundPort = extensionApi.runtime.connect({name: 'contentscript'});
    const backgroundStream = new PortStream(backgroundPort);

    // Стрим к странице
    const pageStream = new PostMessageStream({
        name: 'content',
        target: 'page',
    });

    pageStream.pipe(backgroundStream).pipe(pageStream);
}

function injectScript(){
    try {
        // inject in-page script
        let script = document.createElement('script');
        script.src = extensionApi.extension.getURL('inpage.js');
        const container = document.head || document.documentElement;
        container.insertBefore(script, container.children[0]);
        script.onload = () => script.remove();
    } catch (e) {
        console.error('Injection failed.', e);
    }
}

હવે અમે inpage માં api ઑબ્જેક્ટ બનાવીએ છીએ અને તેને વૈશ્વિક પર સેટ કરીએ છીએ:

import PostMessageStream from 'post-message-stream';
import Dnode from 'dnode/browser';

setupInpageApi().catch(console.error);

async function setupInpageApi() {
    // Стрим к контентскрипту
    const connectionStream = new PostMessageStream({
        name: 'page',
        target: 'content',
    });

    const dnode = Dnode();

    connectionStream.pipe(dnode).pipe(connectionStream);

    // Получаем объект API
    const pageApi = await new Promise(resolve => {
        dnode.once('remote', api => {
            resolve(api)
        })
    });

    // Доступ через window
    global.SignerApp = pageApi;
}

અમે તૈયાર છીએ પૃષ્ઠ અને UI માટે અલગ API સાથે રિમોટ પ્રોસિજર કૉલ (RPC).. નવા પૃષ્ઠને પૃષ્ઠભૂમિ સાથે કનેક્ટ કરતી વખતે આપણે આ જોઈ શકીએ છીએ:

ખાલી API અને મૂળ. પૃષ્ઠ બાજુ પર, આપણે હેલો ફંક્શનને આના જેવું કહી શકીએ:

આધુનિક JS માં કૉલબેક ફંક્શન્સ સાથે કામ કરવું એ ખરાબ રીતભાત છે, તેથી ચાલો એક dnode બનાવવા માટે એક નાનો સહાયક લખીએ જે તમને API ઑબ્જેક્ટને utils પર પસાર કરવાની મંજૂરી આપે છે.

API ઑબ્જેક્ટ હવે આના જેવો દેખાશે:

export class SignerApp {

    popupApi() {
        return {
            hello: async () => "world"
        }
    }

...

}

રિમોટમાંથી આ રીતે ઑબ્જેક્ટ મેળવવું:

import {cbToPromise, transformMethods} from "../../src/utils/setupDnode";

const pageApi = await new Promise(resolve => {
    dnode.once('remote', remoteApi => {
        // С помощью утилит меняем все callback на promise
        resolve(transformMethods(cbToPromise, remoteApi))
    })
});

અને કૉલિંગ કાર્યો વચન આપે છે:

અસુમેળ કાર્યો સાથેનું સંસ્કરણ ઉપલબ્ધ છે અહીં.

એકંદરે, આરપીસી અને સ્ટ્રીમ અભિગમ એકદમ લવચીક લાગે છે: અમે સ્ટીમ મલ્ટિપ્લેક્સિંગનો ઉપયોગ કરી શકીએ છીએ અને વિવિધ કાર્યો માટે વિવિધ API બનાવી શકીએ છીએ. સૈદ્ધાંતિક રીતે, ડીનોડનો ઉપયોગ ગમે ત્યાં થઈ શકે છે, મુખ્ય વસ્તુ એ નોડજ સ્ટ્રીમના સ્વરૂપમાં પરિવહનને લપેટી છે.

વૈકલ્પિક JSON ફોર્મેટ છે, જે JSON RPC 2 પ્રોટોકોલનો અમલ કરે છે. જો કે, તે ચોક્કસ પરિવહન (TCP અને HTTP(S)) સાથે કામ કરે છે, જે અમારા કિસ્સામાં લાગુ પડતું નથી.

આંતરિક રાજ્ય અને સ્થાનિક સંગ્રહ

અમારે એપ્લિકેશનની આંતરિક સ્થિતિ સંગ્રહિત કરવાની જરૂર પડશે - ઓછામાં ઓછી સાઇનિંગ કી. અમે એપ્લિકેશનમાં સ્થિતિ અને તેને પોપઅપ API માં બદલવા માટેની પદ્ધતિઓ સરળતાથી ઉમેરી શકીએ છીએ:

import {setupDnode} from "./utils/setupDnode";

export class SignerApp {

    constructor(){
        this.store = {
            keys: [],
        };
    }

    addKey(key){
        this.store.keys.push(key)
    }

    removeKey(index){
        this.store.keys.splice(index,1)
    }

    popupApi(){
        return {
            addKey: async (key) => this.addKey(key),
            removeKey: async (index) => this.removeKey(index)
        }
    }

    ...

} 

પૃષ્ઠભૂમિમાં, અમે દરેક વસ્તુને ફંક્શનમાં લપેટીશું અને એપ્લિકેશન ઑબ્જેક્ટને વિંડોમાં લખીશું જેથી અમે કન્સોલથી તેની સાથે કામ કરી શકીએ:

import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import {SignerApp} from "./SignerApp";

const DEV_MODE = process.env.NODE_ENV !== 'production';

setupApp();

function setupApp() {
    const app = new SignerApp();

    if (DEV_MODE) {
        global.app = app;
    }

    extensionApi.runtime.onConnect.addListener(connectRemote);

    function connectRemote(remotePort) {
        const processName = remotePort.name;
        const portStream = new PortStream(remotePort);
        if (processName === 'contentscript') {
            const origin = remotePort.sender.url;
            app.connectPage(portStream, origin)
        } else {
            app.connectPopup(portStream)
        }
    }
}

ચાલો UI કન્સોલમાંથી થોડી કી ઉમેરીએ અને જોઈએ કે રાજ્ય સાથે શું થાય છે:

રાજ્યને સતત બનાવવાની જરૂર છે જેથી પુનઃપ્રારંભ કરતી વખતે ચાવીઓ ખોવાઈ ન જાય.

અમે તેને લોકલ સ્ટોરેજમાં સ્ટોર કરીશું, દરેક ફેરફાર સાથે તેને ઓવરરાઈટ કરીશું. ત્યારબાદ, UI માટે પણ તેની ઍક્સેસ જરૂરી રહેશે, અને હું ફેરફારો માટે સબ્સ્ક્રાઇબ કરવા પણ ઈચ્છું છું. તેના આધારે, અવલોકનક્ષમ સ્ટોરેજ બનાવવા અને તેના ફેરફારો માટે સબ્સ્ક્રાઇબ કરવાનું અનુકૂળ રહેશે.

અમે mobx પુસ્તકાલયનો ઉપયોગ કરીશું (https://github.com/mobxjs/mobx). પસંદગી તેના પર પડી કારણ કે મારે તેની સાથે કામ કરવાની જરૂર નહોતી, પરંતુ હું ખરેખર તેનો અભ્યાસ કરવા માંગતો હતો.

ચાલો પ્રારંભિક સ્થિતિની શરૂઆત ઉમેરીએ અને સ્ટોરને અવલોકનક્ષમ બનાવીએ:

import {observable, action} from 'mobx';
import {setupDnode} from "./utils/setupDnode";

export class SignerApp {

    constructor(initState = {}) {
        // Внешне store так и останется тем же объектом, только теперь все его поля стали proxy, которые отслеживают доступ к ним
        this.store =  observable.object({
            keys: initState.keys || [],
        });
    }

    // Методы, которые меняют observable принято оборачивать декоратором
    @action
    addKey(key) {
        this.store.keys.push(key)
    }

    @action
    removeKey(index) {
        this.store.keys.splice(index, 1)
    }

    ...

}

"હૂડ હેઠળ," mobx એ તમામ સ્ટોર ફીલ્ડ્સને પ્રોક્સી સાથે બદલ્યા છે અને તેમને તમામ કૉલ્સને અટકાવે છે. આ સંદેશાઓ પર સબ્સ્ક્રાઇબ કરવાનું શક્ય બનશે.

નીચે હું ઘણી વાર "બદલતી વખતે" શબ્દનો ઉપયોગ કરીશ, જો કે આ સંપૂર્ણ રીતે સાચું નથી. Mobx ફીલ્ડ્સની ઍક્સેસને ટ્રેક કરે છે. લાઇબ્રેરી જે પ્રોક્સી ઓબ્જેક્ટ બનાવે છે તેના ગેટર્સ અને સેટર્સનો ઉપયોગ થાય છે.

એક્શન ડેકોરેટર્સ બે હેતુઓ પૂરા પાડે છે:

1. enforceActions ફ્લેગ સાથે કડક મોડમાં, mobx રાજ્યને સીધું બદલવા પર પ્રતિબંધ મૂકે છે. સખત પરિસ્થિતિઓમાં કામ કરવું એ સારી પ્રથા માનવામાં આવે છે.
2. જો કોઈ ફંક્શન ઘણી વખત સ્ટેટમાં ફેરફાર કરે તો પણ - ઉદાહરણ તરીકે, અમે કોડની કેટલીક લાઇનમાં ઘણા ફીલ્ડ્સ બદલીએ છીએ - નિરીક્ષકોને જ્યારે તે પૂર્ણ થાય ત્યારે જ સૂચિત કરવામાં આવે છે. આ અગ્રભાગ માટે ખાસ કરીને મહત્વપૂર્ણ છે, જ્યાં બિનજરૂરી સ્ટેટ અપડેટ તત્વોના બિનજરૂરી રેન્ડરિંગ તરફ દોરી જાય છે. અમારા કિસ્સામાં, પ્રથમ કે બીજું બેમાંથી કોઈ ખાસ સંબંધિત નથી, પરંતુ અમે શ્રેષ્ઠ પ્રથાઓનું પાલન કરીશું. તે તમામ કાર્યોમાં ડેકોરેટરને જોડવાનો રિવાજ છે જે અવલોકન કરેલ ક્ષેત્રોની સ્થિતિને બદલે છે.

પૃષ્ઠભૂમિમાં અમે લોકલ સ્ટોરેજમાં રાજ્યને આરંભ અને સાચવીશું:

import {reaction, toJS} from 'mobx';
import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import {SignerApp} from "./SignerApp";
// Вспомогательные методы. Записывают/читают объект в/из localStorage виде JSON строки по ключу 'store'
import {loadState, saveState} from "./utils/localStorage";

const DEV_MODE = process.env.NODE_ENV !== 'production';

setupApp();

function setupApp() {
    const initState = loadState();
    const app = new SignerApp(initState);

    if (DEV_MODE) {
        global.app = app;
    }

    // Setup state persistence

    // Результат reaction присваивается переменной, чтобы подписку можно было отменить. Нам это не нужно, оставлено для примера
    const localStorageReaction = reaction(
        () => toJS(app.store), // Функция-селектор данных
        saveState // Функция, которая будет вызвана при изменении данных, которые возвращает селектор
    );

    extensionApi.runtime.onConnect.addListener(connectRemote);

    function connectRemote(remotePort) {
        const processName = remotePort.name;
        const portStream = new PortStream(remotePort);
        if (processName === 'contentscript') {
            const origin = remotePort.sender.url
            app.connectPage(portStream, origin)
        } else {
            app.connectPopup(portStream)
        }
    }
}

પ્રતિક્રિયા કાર્ય અહીં રસપ્રદ છે. તેની બે દલીલો છે:

1. ડેટા સિલેક્ટર.
2. એક હેન્ડલર કે જેને આ ડેટા દર વખતે બદલાય ત્યારે તેની સાથે કૉલ કરવામાં આવશે.

રેડક્સથી વિપરીત, જ્યાં અમે સ્પષ્ટપણે દલીલ તરીકે રાજ્ય પ્રાપ્ત કરીએ છીએ, mobx યાદ રાખે છે કે અમે પસંદગીકારની અંદર કયા અવલોકનક્ષમ વસ્તુઓને ઍક્સેસ કરીએ છીએ, અને જ્યારે તેઓ બદલાય છે ત્યારે જ હેન્ડલરને કૉલ કરે છે.

તે સમજવું અગત્યનું છે કે mobx કેવી રીતે નક્કી કરે છે કે આપણે કયા અવલોકનક્ષમ પર સબ્સ્ક્રાઇબ કરીએ છીએ. જો મેં આના જેવા કોડમાં પસંદગીકાર લખ્યું() => app.store, તો પછી પ્રતિક્રિયા ક્યારેય કહેવાશે નહીં, કારણ કે સંગ્રહ પોતે અવલોકનક્ષમ નથી, ફક્ત તેના ક્ષેત્રો છે.

જો મેં તેને આ રીતે લખ્યું () => app.store.keys, પછી ફરીથી કંઈ થશે નહીં, કારણ કે જ્યારે એરે તત્વો ઉમેરી/દૂર કરી રહ્યા હોય, ત્યારે તેનો સંદર્ભ બદલાશે નહીં.

Mobx પ્રથમ વખત પસંદગીકાર તરીકે કાર્ય કરે છે અને માત્ર અમે એક્સેસ કરેલ અવલોકનક્ષમ વસ્તુઓનો જ ટ્રૅક રાખે છે. આ પ્રોક્સી ગેટર દ્વારા કરવામાં આવે છે. તેથી, બિલ્ટ-ઇન ફંક્શનનો ઉપયોગ અહીં થાય છે toJS. તે મૂળ ક્ષેત્રો સાથે બદલાયેલ તમામ પ્રોક્સીઓ સાથે એક નવો ઑબ્જેક્ટ પરત કરે છે. એક્ઝેક્યુશન દરમિયાન, તે ઑબ્જેક્ટના તમામ ક્ષેત્રોને વાંચે છે - તેથી ગેટર્સ ટ્રિગર થાય છે.

પોપઅપ કન્સોલમાં આપણે ફરીથી ઘણી કી ઉમેરીશું. આ વખતે તેઓ લોકલ સ્ટોરેજમાં પણ સમાપ્ત થયા:

જ્યારે પૃષ્ઠભૂમિ પૃષ્ઠ ફરીથી લોડ થાય છે, ત્યારે માહિતી સ્થાને રહે છે.

આ બિંદુ સુધીના તમામ એપ્લિકેશન કોડ જોઈ શકાય છે અહીં.

ખાનગી કીઓનો સુરક્ષિત સંગ્રહ

સ્પષ્ટ લખાણમાં ખાનગી કીને સંગ્રહિત કરવી અસુરક્ષિત છે: તમને હેક કરવામાં આવશે, તમારા કોમ્પ્યુટરની ઍક્સેસ મેળવો, વગેરે એવી શક્યતા હંમેશા રહે છે. તેથી, લોકલ સ્ટોરેજમાં આપણે કીને પાસવર્ડ-એન્ક્રિપ્ટેડ સ્વરૂપમાં સંગ્રહિત કરીશું.

વધુ સુરક્ષા માટે, અમે એપ્લિકેશનમાં એક લૉક કરેલી સ્થિતિ ઉમેરીશું, જેમાં ચાવીઓની બિલકુલ ઍક્સેસ હશે નહીં. સમય સમાપ્ત થવાને કારણે અમે એક્સ્ટેંશનને લૉક કરેલ સ્થિતિમાં આપમેળે સ્થાનાંતરિત કરીશું.

Mobx તમને ડેટાના ન્યૂનતમ સેટને સંગ્રહિત કરવાની મંજૂરી આપે છે, અને બાકીની આપમેળે તેના આધારે ગણતરી કરવામાં આવે છે. આ કહેવાતા ગણિત ગુણધર્મો છે. તેમની તુલના ડેટાબેઝમાં જોવાઈ સાથે કરી શકાય છે:

import {observable, action} from 'mobx';
import {setupDnode} from "./utils/setupDnode";
// Утилиты для безопасного шифрования строк. Используют crypto-js
import {encrypt, decrypt} from "./utils/cryptoUtils";

export class SignerApp {
    constructor(initState = {}) {
        this.store = observable.object({
            // Храним пароль и зашифрованные ключи. Если пароль null - приложение locked
            password: null,
            vault: initState.vault,

            // Геттеры для вычислимых полей. Можно провести аналогию с view в бд.
            get locked(){
                return this.password == null
            },
            get keys(){
                return this.locked ?
                    undefined :
                    SignerApp._decryptVault(this.vault, this.password)
            },
            get initialized(){
                return this.vault !== undefined
            }
        })
    }
    // Инициализация пустого хранилища новым паролем
    @action
    initVault(password){
        this.store.vault = SignerApp._encryptVault([], password)
    }
    @action
    lock() {
        this.store.password = null
    }
    @action
    unlock(password) {
        this._checkPassword(password);
        this.store.password = password
    }
    @action
    addKey(key) {
        this._checkLocked();
        this.store.vault = SignerApp._encryptVault(this.store.keys.concat(key), this.store.password)
    }
    @action
    removeKey(index) {
        this._checkLocked();
        this.store.vault = SignerApp._encryptVault([
                ...this.store.keys.slice(0, index),
                ...this.store.keys.slice(index + 1)
            ],
            this.store.password
        )
    }

    ... // код подключения и api

    // private
    _checkPassword(password) {
        SignerApp._decryptVault(this.store.vault, password);
    }

    _checkLocked() {
        if (this.store.locked){
            throw new Error('App is locked')
        }
    }

    // Методы для шифровки/дешифровки хранилища
    static _encryptVault(obj, pass){
        const jsonString = JSON.stringify(obj)
        return encrypt(jsonString, pass)
    }

    static _decryptVault(str, pass){
        if (str === undefined){
            throw new Error('Vault not initialized')
        }
        try {
            const jsonString = decrypt(str, pass)
            return JSON.parse(jsonString)
        }catch (e) {
            throw new Error('Wrong password')
        }
    }
}

હવે અમે ફક્ત એન્ક્રિપ્ટેડ કી અને પાસવર્ડ સ્ટોર કરીએ છીએ. બાકીનું બધું ગણાય છે. અમે રાજ્યમાંથી પાસવર્ડ દૂર કરીને લૉક કરેલી સ્થિતિમાં ટ્રાન્સફર કરીએ છીએ. સાર્વજનિક API પાસે હવે સ્ટોરેજ શરૂ કરવાની પદ્ધતિ છે.

એન્ક્રિપ્શન માટે લખાયેલ ક્રિપ્ટો-જેએસનો ઉપયોગ કરીને ઉપયોગિતાઓ:

import CryptoJS from 'crypto-js'

// Используется для осложнения подбора пароля перебором. На каждый вариант пароля злоумышленнику придется сделать 5000 хешей
function strengthenPassword(pass, rounds = 5000) {
    while (rounds-- > 0){
        pass = CryptoJS.SHA256(pass).toString()
    }
    return pass
}

export function encrypt(str, pass){
    const strongPass = strengthenPassword(pass);
    return CryptoJS.AES.encrypt(str, strongPass).toString()
}

export function decrypt(str, pass){
    const strongPass = strengthenPassword(pass)
    const decrypted = CryptoJS.AES.decrypt(str, strongPass);
    return decrypted.toString(CryptoJS.enc.Utf8)
}

બ્રાઉઝરમાં એક નિષ્ક્રિય API છે જેના દ્વારા તમે ઇવેન્ટમાં સબ્સ્ક્રાઇબ કરી શકો છો - સ્ટેટ ફેરફારો. રાજ્ય, તે મુજબ, હોઈ શકે છે idle, active и locked. નિષ્ક્રિય માટે તમે સમયસમાપ્તિ સેટ કરી શકો છો, અને જ્યારે OS પોતે જ અવરોધિત હોય ત્યારે લૉક સેટ થાય છે. અમે લોકલ સ્ટોરેજમાં સાચવવા માટે પસંદગીકારને પણ બદલીશું:

import {reaction, toJS} from 'mobx';
import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import {SignerApp} from "./SignerApp";
import {loadState, saveState} from "./utils/localStorage";

const DEV_MODE = process.env.NODE_ENV !== 'production';
const IDLE_INTERVAL = 30;

setupApp();

function setupApp() {
    const initState = loadState();
    const app = new SignerApp(initState);

    if (DEV_MODE) {
        global.app = app;
    }

    // Теперь мы явно узываем поле, которому будет происходить доступ, reaction отработает нормально
    reaction(
        () => ({
            vault: app.store.vault
        }),
        saveState
    );

    // Таймаут бездействия, когда сработает событие
    extensionApi.idle.setDetectionInterval(IDLE_INTERVAL);
    // Если пользователь залочил экран или бездействовал в течение указанного интервала лочим приложение
    extensionApi.idle.onStateChanged.addListener(state => {
        if (['locked', 'idle'].indexOf(state) > -1) {
            app.lock()
        }
    });

    // Connect to other contexts
    extensionApi.runtime.onConnect.addListener(connectRemote);

    function connectRemote(remotePort) {
        const processName = remotePort.name;
        const portStream = new PortStream(remotePort);
        if (processName === 'contentscript') {
            const origin = remotePort.sender.url
            app.connectPage(portStream, origin)
        } else {
            app.connectPopup(portStream)
        }
    }
}

આ પગલા પહેલાનો કોડ છે અહીં.

વ્યવહાર

તેથી, અમે સૌથી મહત્વની બાબત પર આવીએ છીએ: બ્લોકચેન પર વ્યવહારો બનાવવા અને હસ્તાક્ષર કરવા. અમે WAVES બ્લોકચેન અને લાઇબ્રેરીનો ઉપયોગ કરીશું તરંગો-વ્યવહારો.

પ્રથમ, ચાલો રાજ્યમાં સંદેશાઓની શ્રેણી ઉમેરીએ કે જેના પર સહી કરવાની જરૂર છે, પછી નવો સંદેશ ઉમેરવા, હસ્તાક્ષરની પુષ્ટિ કરવા અને નકારવા માટેની પદ્ધતિઓ ઉમેરો:

import {action, observable, reaction} from 'mobx';
import uuid from 'uuid/v4';
import {signTx} from '@waves/waves-transactions'
import {setupDnode} from "./utils/setupDnode";
import {decrypt, encrypt} from "./utils/cryptoUtils";

export class SignerApp {

    ...

    @action
    newMessage(data, origin) {
        // Для каждого сообщения создаем метаданные с id, статусом, выременем создания и тд.
        const message = observable.object({
            id: uuid(), // Идентификатор, используюю uuid
            origin, // Origin будем впоследствии показывать в интерфейсе
            data, //
            status: 'new', // Статусов будет четыре: new, signed, rejected и failed
            timestamp: Date.now()
        });
        console.log(`new message: ${JSON.stringify(message, null, 2)}`);

        this.store.messages.push(message);

        // Возвращаем промис внутри которого mobx мониторит изменения сообщения. Как только статус поменяется мы зарезолвим его
        return new Promise((resolve, reject) => {
            reaction(
                () => message.status, //Будем обсервить статус сообщеня
                (status, reaction) => { // второй аргумент это ссылка на сам reaction, чтобы его можно было уничтожть внутри вызова
                    switch (status) {
                        case 'signed':
                            resolve(message.data);
                            break;
                        case 'rejected':
                            reject(new Error('User rejected message'));
                            break;
                        case 'failed':
                            reject(new Error(message.err.message));
                            break;
                        default:
                            return
                    }
                    reaction.dispose()
                }
            )
        })
    }
    @action
    approve(id, keyIndex = 0) {
        const message = this.store.messages.find(msg => msg.id === id);
        if (message == null) throw new Error(`No msg with id:${id}`);
        try {
            message.data = signTx(message.data, this.store.keys[keyIndex]);
            message.status = 'signed'
        } catch (e) {
            message.err = {
                stack: e.stack,
                message: e.message
            };
            message.status = 'failed'
            throw e
        }
    }
    @action
    reject(id) {
        const message = this.store.messages.find(msg => msg.id === id);
        if (message == null) throw new Error(`No msg with id:${id}`);
        message.status = 'rejected'
    }

    ...
}

જ્યારે અમને નવો સંદેશ મળે છે, ત્યારે અમે તેમાં મેટાડેટા ઉમેરીએ છીએ, કરો observable અને ઉમેરો store.messages.

જો તમે ના કરો observable મેન્યુઅલી, પછી એરેમાં સંદેશાઓ ઉમેરતી વખતે mobx તે પોતે કરશે. જો કે, તે એક નવો ઑબ્જેક્ટ બનાવશે જેનો અમારી પાસે કોઈ સંદર્ભ નથી, પરંતુ અમને આગલા પગલા માટે તેની જરૂર પડશે.

આગળ, અમે એક વચન પરત કરીએ છીએ જે સંદેશની સ્થિતિ બદલાય ત્યારે ઉકેલાઈ જાય છે. પ્રતિક્રિયા દ્વારા સ્થિતિનું નિરીક્ષણ કરવામાં આવે છે, જે સ્થિતિ બદલાય ત્યારે "પોતાને મારી નાખશે".

પદ્ધતિ કોડ approve и reject ખૂબ જ સરળ: જો જરૂરી હોય તો સાઇન કર્યા પછી, અમે ફક્ત સંદેશની સ્થિતિ બદલીએ છીએ.

અમે UI API માં મંજૂર અને અસ્વીકાર મૂકીએ છીએ, પેજ API માં નવો સંદેશ:

export class SignerApp {
    ...
    popupApi() {
        return {
            addKey: async (key) => this.addKey(key),
            removeKey: async (index) => this.removeKey(index),

            lock: async () => this.lock(),
            unlock: async (password) => this.unlock(password),
            initVault: async (password) => this.initVault(password),

            approve: async (id, keyIndex) => this.approve(id, keyIndex),
            reject: async (id) => this.reject(id)
        }
    }

    pageApi(origin) {
        return {
            signTransaction: async (txParams) => this.newMessage(txParams, origin)
        }
    }

    ...
}

હવે ચાલો એક્સ્ટેંશન સાથે ટ્રાન્ઝેક્શન પર સહી કરવાનો પ્રયાસ કરીએ:

સામાન્ય રીતે, બધું તૈયાર છે, જે બાકી છે તે છે સરળ UI ઉમેરો.

UI

ઇન્ટરફેસને એપ્લિકેશન સ્ટેટની ઍક્સેસની જરૂર છે. UI બાજુએ અમે કરીશું observable સ્ટેટ કરો અને API માં ફંક્શન ઉમેરો જે આ સ્થિતિને બદલશે. ચાલો ઉમેરીએ observable પૃષ્ઠભૂમિમાંથી પ્રાપ્ત API ઑબ્જેક્ટ પર:

import {observable} from 'mobx'
import {extensionApi} from "./utils/extensionApi";
import {PortStream} from "./utils/PortStream";
import {cbToPromise, setupDnode, transformMethods} from "./utils/setupDnode";
import {initApp} from "./ui/index";

const DEV_MODE = process.env.NODE_ENV !== 'production';

setupUi().catch(console.error);

async function setupUi() {
    // Подключаемся к порту, создаем из него стрим
    const backgroundPort = extensionApi.runtime.connect({name: 'popup'});
    const connectionStream = new PortStream(backgroundPort);

    // Создаем пустой observable для состояния background'a
    let backgroundState = observable.object({});
    const api = {
        //Отдаем бекграунду функцию, которая будет обновлять observable
        updateState: async state => {
            Object.assign(backgroundState, state)
        }
    };

    // Делаем RPC объект
    const dnode = setupDnode(connectionStream, api);
    const background = await new Promise(resolve => {
        dnode.once('remote', remoteApi => {
            resolve(transformMethods(cbToPromise, remoteApi))
        })
    });

    // Добавляем в background observable со стейтом
    background.state = backgroundState;

    if (DEV_MODE) {
        global.background = background;
    }

    // Запуск интерфейса
    await initApp(background)
}

અંતે અમે એપ્લિકેશન ઇન્ટરફેસ રેન્ડર કરવાનું શરૂ કરીએ છીએ. આ એક રિએક્ટ એપ્લિકેશન છે. પૃષ્ઠભૂમિ ઑબ્જેક્ટ પ્રોપ્સનો ઉપયોગ કરીને સરળ રીતે પસાર થાય છે. તે સાચું હશે, અલબત્ત, પદ્ધતિઓ માટે એક અલગ સેવા અને રાજ્ય માટે સ્ટોર બનાવવી, પરંતુ આ લેખના હેતુઓ માટે આ પૂરતું છે:

import {render} from 'react-dom'
import App from './App'
import React from "react";

// Инициализируем приложение с background объектом в качест ве props
export async function initApp(background){
    render(
        <App background={background}/>,
        document.getElementById('app-content')
    );
}

જ્યારે ડેટા બદલાય ત્યારે રેન્ડરિંગ શરૂ કરવું mobx સાથે ખૂબ જ સરળ છે. અમે ફક્ત પેકેજમાંથી નિરીક્ષક ડેકોરેટરને અટકી જઈએ છીએ mobx-પ્રતિક્રિયા ઘટક પર, અને રેન્ડર આપોઆપ કૉલ કરવામાં આવશે જ્યારે ઘટક ફેરફાર દ્વારા સંદર્ભિત કોઈપણ અવલોકનક્ષમ. તમારે કોઈ મેપસ્ટેટટોપ્રોપ્સની જરૂર નથી અથવા રેડક્સની જેમ કનેક્ટ કરવાની જરૂર નથી. બધું જ બૉક્સની બહાર કામ કરે છે:

import React, {Component, Fragment} from 'react'
import {observer} from "mobx-react";
import Init from './components/Initialize'
import Keys from './components/Keys'
import Sign from './components/Sign'
import Unlock from './components/Unlock'

@observer // У Компонета с этим декоратом будет автоматически вызван метод render, если будут изменены observable на которые он ссылается
export default class App extends Component {

    // Правильно конечно вынести логику рендера страниц в роутинг и не использовать вложенные тернарные операторы,
    // и привязывать observable и методы background непосредственно к тем компонентам, которые их используют
    render() {
        const {keys, messages, initialized, locked} = this.props.background.state;
        const {lock, unlock, addKey, removeKey, initVault, deleteVault, approve, reject} = this.props.background;

        return <Fragment>
            {!initialized
                ?
                <Init onInit={initVault}/>
                :
                locked
                    ?
                    <Unlock onUnlock={unlock}/>
                    :
                    messages.length > 0
                        ?
                        <Sign keys={keys} message={messages[messages.length - 1]} onApprove={approve} onReject={reject}/>
                        :
                        <Keys keys={keys} onAdd={addKey} onRemove={removeKey}/>
            }
            <div>
                {!locked && <button onClick={() => lock()}>Lock App</button>}
                {initialized && <button onClick={() => deleteVault()}>Delete all keys and init</button>}
            </div>
        </Fragment>
    }
}

બાકીના ઘટકો કોડમાં જોઈ શકાય છે UI ફોલ્ડરમાં.

હવે એપ્લીકેશન ક્લાસમાં તમારે UI માટે સ્ટેટ સિલેક્ટર બનાવવાની જરૂર છે અને જ્યારે UI બદલાય ત્યારે તેને સૂચિત કરવું પડશે. આ કરવા માટે, ચાલો એક પદ્ધતિ ઉમેરીએ getState и reactionકૉલિંગ remote.updateState:

import {action, observable, reaction} from 'mobx';
import uuid from 'uuid/v4';
import {signTx} from '@waves/waves-transactions'
import {setupDnode} from "./utils/setupDnode";
import {decrypt, encrypt} from "./utils/cryptoUtils";

export class SignerApp {

    ...

    // public
    getState() {
        return {
            keys: this.store.keys,
            messages: this.store.newMessages,
            initialized: this.store.initialized,
            locked: this.store.locked
        }
    }

    ...

    //
    connectPopup(connectionStream) {
        const api = this.popupApi();
        const dnode = setupDnode(connectionStream, api);

        dnode.once('remote', (remote) => {
            // Создаем reaction на изменения стейта, который сделает вызовет удаленну процедуру и обновит стейт в ui процессе
            const updateStateReaction = reaction(
                () => this.getState(),
                (state) => remote.updateState(state),
                // Третьим аргументом можно передавать параметры. fireImmediatly значит что reaction выполниться первый раз сразу.
                // Это необходимо, чтобы получить начальное состояние. Delay позволяет установить debounce
                {fireImmediately: true, delay: 500}
            );
            // Удалим подписку при отключении клиента
            dnode.once('end', () => updateStateReaction.dispose())

        })
    }

    ...
}

ઑબ્જેક્ટ પ્રાપ્ત કરતી વખતે remote બનાવવામાં આવી રહી છે reaction UI બાજુ પર ફંક્શનને કૉલ કરતી સ્થિતિને બદલવા માટે.

અંતિમ સ્પર્શ એ એક્સ્ટેંશન આયકન પર નવા સંદેશાઓનું પ્રદર્શન ઉમેરવાનું છે:

function setupApp() {
...

    // Reaction на выставление текста беджа.
    reaction(
        () => app.store.newMessages.length > 0 ? app.store.newMessages.length.toString() : '',
        text => extensionApi.browserAction.setBadgeText({text}),
        {fireImmediately: true}
    );

...
}

તેથી, એપ્લિકેશન તૈયાર છે. વેબ પૃષ્ઠો વ્યવહારો માટે સહી માટે વિનંતી કરી શકે છે:

કોડ અહીં ઉપલબ્ધ છે કડી.

નિષ્કર્ષ

જો તમે લેખને અંત સુધી વાંચ્યો હોય, પરંતુ હજુ પણ પ્રશ્નો હોય, તો તમે તેમને અહીં પૂછી શકો છો એક્સ્ટેંશન સાથે રીપોઝીટરીઝ. ત્યાં તમને દરેક નિયુક્ત પગલા માટે કમિટ પણ મળશે.

અને જો તમને વાસ્તવિક એક્સ્ટેંશન માટે કોડ જોવામાં રસ હોય, તો તમે આ શોધી શકો છો અહીં.

તરફથી કોડ, રીપોઝીટરી અને જોબ વર્ણન સિમેરેલ

સોર્સ: www.habr.com