Arhiva Express.js - Tomislav Stanković

Implementacija CorvusPay kartičnog plaćanja koristeći Node.js, Express.js i Angular

U ovom blog postu možete saznati kako implementirati CorvusPay kartično plaćanje koristeći Node.js tj. Express.js i Angular Framework.

Kartično plaćanje provodi se kroz Corvus Form Service što znači da korisnik nakon odabira artikala bude preusmjeren na URL za autorizaciju kreditne kartice. Na tom URL-u ispunjava se obrazac s potrebnim podacima o kreditnoj kartici nakon čega korisnik ponovno bude preusmjeren na web shop gdje se najčešće prikazuje poruka o ne/uspješnoj kupovini.

Tijek transakcije kroz CorvusPay sustav odvija se na sljedeći način:

Kupac u web trgovini odabire proizvod ili uslugu koju želi platiti karticom.

Kupac se preusmjerava sa stranice trgovca na CorvusPay platnu formu (stranicu) gdje unosi podatke potrebne za realizaciju kartične transakcije.

CorvusPay šalje banci zahtjev za autorizacijom.

Banka šalje odgovor na zahtjev za autorizacijom na CorvusPay.

CorvusPay preusmjerava kupca na cancel ili success url kojeg definira trgovac ovisno o ishodu transakcije.

Moguća je i integracija tog obrasca unutar web shopa, ali u tom slučaju trgovac mora imati PCI DSS certifikat.

Tijek implementacije

Proces se istovremeno odvija u dva smjera. Prvi se tiče administrativnih poslova u kojima Corvus od trgovca prikuplja potrebnu dokumentaciju za pokretanje procesa aktivacije kartičnog plaćanje koju prosljeđuje prema bankama/kartičnim kućama.

Paralelno trgovac (web shop) postavlja obavezan sadržaj na web trgovinu (uvjeti korištenja i plaćanja, logo CorvusPaya,…), vrši implementaciju prema dostupnim uputama i testira sustav pomoću razvojnog certifikata. Nakon obavljenih testova postavlja se produkcijski certifikat čime se proces implementacije završava.

Uvod

Komunikacija između trgovca i usluge CorvusPay vrši se putem HTTPS POST web zahtjeva.

Svaki web zahtjev prema Corvusu treba obavezno sadržavati tri parametra, a to su:

– Store ID
– Secret Key
– Client Certificate (.p12).

Dobiju se dva seta ovih podataka. Jedan set za testiranje, a drugi za produkciju.

Obavezni CorvusPay parametri

Obavezni parametri su: version, store_id, order_number, language, currency, amount, cart, signature i require_complete.

U slučaju greške pri kreiranju parametara prikazat će se sljedeći ekran:

CorvusPay greška — Vaš zahtjev ne može biti obrađen – CorvusPay

order_number mora biti jedinstven jer sustav će provjeriti i odbiti svaki upit na Corvus API ako narudžba s istim brojem narudžbe već postoji.

signature se kreira koristeći HMAC-SHA256. On se sastoji od svih obaveznih i opcionalnih vrijednosti (key-value field pairs), poredanih abecedno i spojenih bez razmaka.

To onda izgleda ovako:

amount10.00cartkindlepaperwhitecurrencyHRKlanguagehrorder_number1537270065109require_completefalsestore_id2029version1.3

1	amount10.00cartkindlepaperwhitecurrencyHRKlanguagehrorder_number1537270065109require_completefalsestore_id2029version1.3

na osnovu čega se dobije signature

6cc62fa239555f790b5665d4b002faa5b1d90ded5e4caa3e70d37a4db88d6d51

1	6cc62fa239555f790b5665d4b002faa5b1d90ded5e4caa3e70d37a4db88d6d51

signature = HMAC-256(key, key-value field pairs)

~ ključ: UNV3-i2otJw0rUWzA2lpcNRqTOYRWdAeTw
~ parametri:
– version : 1.3
– store_id : 2029
– order_number : 1537270065109
– amount : 10.00
– currency : HRK
– cart : kindle paperwhite
– require_complete : false
– language : hr

CorvusPay HTTPS POST — CorvusPay Integration Manual v5.1.0

Neobavezni CorvusPay parametri

Osim obaveznih parametara moguće je koristiti i neobavezne. U ovom slučaju to će biti parametri vezani uz plaćanje na rate.

Tri su načina pokretanja transakcije na rate:
• Fiksni broj rata
• Fleksibilan broj rata
• Samostalan odabir rata za određenu karticu

Napomene:
• Ako se za određenu platnu karticu ne pošalje parametar payment_brandName kartica neće biti dostupna za odabir
• Prvi znak parametra payment_ trebao bi biti jednak N ili Y jer to označava je li dozvoljeno jednokratno plaćanje ili ne
• Posljednja četiri znaka određuju raspon broja rata. Kupac može odabrati broj rata u rasponu između prvog dvoznamenkastog broja i drugog dvoznamenkastog broja

CorvusPay plaćanje na rate — CorvusPay Integration Manual v5.1.0

Web aplikacija (Angular)

Unutar forme pomoću POST metode poziva se API za pokretanje kartičnog plaćanja.

Sve navedene vrijednosti su promjenjive tako da ih prilikom svake promjene unutar .ts datoteke treba osvježiti i unutar forme </form>.

Parametri signature i payment_ mogu se kreirati na frontendu i backendu. U ovom slučaju oni će se kreirati na frontendu i prosljeđivati kroz formu na API.

<form [action]="'https://localhost:3000/api/corvus/'" ngNoForm method="POST" target="_self">
  <button [disabled]="disableSecondClick" class="btn-pay" type="submit">Plati karticom</button>
  <div hidden>
       <input name='order_number' value='{{orderNumber}}'>
       <input name='amount' value='{{paymentForm.value.amount}}'>
       <input name='cart' value='{{paymentForm.value.cart}}'>
       <input name='signature' value='{{paymentForm.value.signature}}'>
       <input name='payment_visa' value='{{paymentForm.value.payment_visa}}'>
       <input name='payment_master' value='{{paymentForm.value.payment_master}}'>
       <input name='payment_maestro' value='{{paymentForm.value.payment_maestro}}'>
       <input name='payment_diners' value='{{paymentForm.value.payment_diners}}'>
  </div>
</form>

<button [disabled]="disableSecondClick" class="btn-pay" type="submit">Plati karticom</button>

</div>

</form>

Za potrebu kreiranja HmacSHA256 potpisa koristi se crypto-js. Uz to, unutar environment varijable nalaze se razvojni i produkcijski parametri secretKey i storeId.

import * as crypto from 'crypto-js';
import * as HmacSHA256 from 'crypto-js/hmac-sha256';

import { environment } from './../../environments/environment';

...

import * as crypto from 'crypto-js';

import * as HmacSHA256 from 'crypto-js/hmac-sha256';

import { environment } from './../../environments/environment';

...

Glavna razlika u ovom dijelu tiče se ukupne cijene tj. ovisno o tome prelazi li iznos od 500kn plaćanje na rate biti će odobreno ili onemogućeno. U oba slučaja kreira se različit signature.

Za ukupan iznos veći ili jednak 500kn koristi se sljedeće:

this.value_pairs="amount"+this.amountTotal.toFixed(2)+
                 "cart"+this.orderedItem+
                 "currencyHRK"+
                 "languagehr"+
                 "order_number"+this.orderNumber+
                 "payment_all_dynamictrue"+
                 "payment_dinersY0112"+
                 "payment_maestroY0112"+
                 "payment_masterY0112"+
                 "payment_visaY0112"+"require_completefalse"+
                 "store_id"+environment.storeId+
                 "version1.3";
this.signature = HmacSHA256(this.value_pairs,environment.secretKey).toString(crypto.enc.Hex);
this.paymentForm.patchValue({
        amount: this.amountTotal.toFixed(2),
        signature: this.signature,
        payment_visa: 'Y0112',
        payment_master: 'Y0112',
        payment_maestro: 'Y0112',
        payment_diners: 'Y0112'
});

this.value_pairs="amount"+this.amountTotal.toFixed(2)+

"cart"+this.orderedItem+

"currencyHRK"+

"languagehr"+

"order_number"+this.orderNumber+

"payment_all_dynamictrue"+

"payment_dinersY0112"+

"payment_maestroY0112"+

"payment_masterY0112"+

"payment_visaY0112"+"require_completefalse"+

"store_id"+environment.storeId+

"version1.3";

this.signature = HmacSHA256(this.value_pairs,environment.secretKey).toString(crypto.enc.Hex);

this.paymentForm.patchValue({

amount: this.amountTotal.toFixed(2),

signature: this.signature,

payment_visa: 'Y0112',

payment_master: 'Y0112',

payment_maestro: 'Y0112',

payment_diners: 'Y0112'

});

Dok se za iznose manje od 500kn koristi:

this.value_pairs="amount"+this.amountTotal.toFixed(2)+
                 "cart"+this.orderedItem+
                 "currencyHRK"+
                 "languagehr"+
                 "order_number"+this.orderNumber+
                 "payment_all_dynamictrue"+
                 "payment_dinersY0000"+
                 "payment_maestroY0000"+
                 "payment_masterY0000"+
                 "payment_visaY0000"+
                 "require_completefalse"+
                 "store_id"+environment.storeId+
                 "version1.3";
this.signature = HmacSHA256(this.value_pairs,environment.secretKey).toString(crypto.enc.Hex);
this.paymentForm.patchValue({
         amount: this.amountTotal.toFixed(2),
         signature: this.signature,
         payment_visa: 'Y0000',
         payment_master: 'Y0000',
         payment_maestro: 'Y0000',
         payment_diners: 'Y0000'
});

this.value_pairs="amount"+this.amountTotal.toFixed(2)+

"cart"+this.orderedItem+

"currencyHRK"+

"languagehr"+

"order_number"+this.orderNumber+

"payment_all_dynamictrue"+

"payment_dinersY0000"+

"payment_maestroY0000"+

"payment_masterY0000"+

"payment_visaY0000"+

"require_completefalse"+

"store_id"+environment.storeId+

"version1.3";

this.signature = HmacSHA256(this.value_pairs,environment.secretKey).toString(crypto.enc.Hex);

this.paymentForm.patchValue({

amount: this.amountTotal.toFixed(2),

signature: this.signature,

payment_visa: 'Y0000',

payment_master: 'Y0000',

payment_maestro: 'Y0000',

payment_diners: 'Y0000'

});

Backend API (Express.js)

Backend logika nalazit će se u server.js datoteci. Kako ju kreirati možete se vidjeti u blog postu “Izrada RESTful API-ja koristeći Node.js i Express.js“. Razlika između primjera iz tog blog posta i ovoga sada je što više nije potrebno koristiti body-parser.

var express = require('express');
var app = express();

app.use(express.json());
app.use(express.urlencoded({ extended: true }));
app.use('/api', apiRoutes);

var port = process.env.PORT || 3000;
 
var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {
    res.json({ message: 'CorvusPay API je pokrenut!' });
});

...

app.listen(port);

var express = require('express');

var app = express();

app.use(express.json());

app.use(express.urlencoded({ extended: true }));

app.use('/api', apiRoutes);

var port = process.env.PORT || 3000;

var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {

res.json({ message: 'CorvusPay API je pokrenut!' });

});

...

app.listen(port);

Ova će se datoteka sastojati od tri krajnje točke (API endpoints).

Prva krajnja točka, '/corvusPay', preusmjerit će korisnika na formu za plaćanje.

apiRoutes.post('/corvusPay', function(req, res) {
    if(req.body.order_number && req.body.amount){
        res.status(301).redirect(307, 'https://test-wallet.corvuspay.com/checkout/?store_id=2029&order_number='+req.body.order_number+'&language=hr&currency=HRK&amount='+req.body.amount+'&cart='+req.body.cart+'&signature='+req.body.signature+'&require_complete=false&version=1.3&payment_all_dynamic=true&payment_visa='+req.body.payment_visa+'&payment_master='+req.body.payment_master+'&payment_maestro='+req.body.payment_maestro+'&payment_diners='+req.body.payment_diners)
    } else {
        res.json({
            success: false,
            status: 502,
            message: 'Greška, ne šaljete sve potrebne podatke za plaćanje!'
        });
    }
});

apiRoutes.post('/corvusPay', function(req, res) {

if(req.body.order_number && req.body.amount){

res.status(301).redirect(307, 'https://test-wallet.corvuspay.com/checkout/?store_id=2029&order_number='+req.body.order_number+'&language=hr&currency=HRK&amount='+req.body.amount+'&cart='+req.body.cart+'&signature='+req.body.signature+'&require_complete=false&version=1.3&payment_all_dynamic=true&payment_visa='+req.body.payment_visa+'&payment_master='+req.body.payment_master+'&payment_maestro='+req.body.payment_maestro+'&payment_diners='+req.body.payment_diners)

} else {

res.json({

success: false,

status: 502,

message: 'Greška, ne šaljete sve potrebne podatke za plaćanje!'

});

}

});

Nakon unosa i obrade podataka o kartici

CorvusPay - obrada u tijeku — CorvusPay – obrada u tijeku

korisnik je preusmjeren na dodatnu sigurnosnu autentifikaciju kartice.

CorvusPay - sigurnosna autentifikacija kartice — CorvusPay – sigurnosna autentifikacija kartice

Ako je sve prošlo uspješno korisniku će se prikazati obavijest

CorvusPay - transakcija-uspjela — CorvusPay – transakcija uspjela

i na e-mail će dobiti obavijest o uspješnoj narudžbi.

CorvusPay - obavijest o uspješnoj narudžbi — CorvusPay – obavijest o uspješnoj narudžbi

Druga krajnja točka, '/corvusPaySuccess' , prihvaća odgovor od Corvusa kada je plaćanje uspješno provedeno.

apiRoutes.post('/corvusPaySuccess', function(req, res) {
    res.status(200).redirect(301, 'https://localhost/success/'+req.body.order_number)
    ...
});

apiRoutes.post('/corvusPaySuccess', function(req, res) {

res.status(200).redirect(301, 'https://localhost/success/'+req.body.order_number)

...

});

Treća krajnja točka, '/corvusPayCancel' , prihvaća odgovor od Corvusa kada je plaćanje neuspješno ili otkazano.

apiRoutes.post('/corvusPayCancel', function(req, res) {
    res.status(200).redirect(301, 'https://localhost/cancel/'+req.body.order_number)
    ...
});

apiRoutes.post('/corvusPayCancel', function(req, res) {

res.status(200).redirect(301, 'https://localhost/cancel/'+req.body.order_number)

...

});

HelmetJS – zaštita HTTP headera Express.js aplikacija

Sigurnost, jedna od stvari s kojoj svi prilikom razvoja aplikacije govore, ali ju malo njih smatra ozbiljnom ili odgađa za kasnije.

S druge strane, HTTP headeri su nešto što korisnici Express.js aplikacije ne vide i onda je developerima lako zapostaviti ih i gledati na njih kao na nešto nebitno. S obzirom da headeri daju razne informacije koje osobe s lošim namjerama mogu iskoristiti jasno je zašto ipak treba voditi brigu o njima tj. informacijama koje pružaju.

Jedna od tih informacije je X-Powered-By: Express što web pregledniku govori što pokreće aplikaciju tj. na čemu se temelji. Helmet.js će, između ostalog, sakriti ovu informaciju.

Zato je cilj ovog blog posta pokazati kako na brz i jednostavan način zaštititi Express.js aplikaciju koristeći Helmet.js koji neće riješiti sve sigurnosne probleme, ali je ipak odličan početak.

Što je Helmet.js?

Helmet.js je kolekcija od 14 modula koje se brinu za sigurnost HTTP zaglavlja (headers) točnije response headera.

7 od 14 modula aktiviraju se jednom linijom koda

app.use(helmet())

1	app.use(helmet())

Osim toga, svaki od tih zadanih modula moguće je individualno aktivirati

app.use(helmet.noCache())
app.use(helmet.frameguard())

1 2	app.use(helmet.noCache()) app.use(helmet.frameguard())

ili deaktivirati

app.use(helmet({
  frameguard: false
}))

app.use(helmet({

frameguard: false

}))

Helmet.js moduli

Trenutno postoji 14 modula (defaultni označeni sa (✓)), a to su sljedeći:

1.) contentSecurityPolicy

Sets the Content-Security-Policy header which can help protect against malicious injection of JavaScript, CSS, plugins, and more.

2.) crossdomain

Prevents Adobe Flash and Adobe Acrobat from loading content on your site.

3.) dnsPrefetchControl (✓)

This middleware lets you disable browsers’ DNS prefetching by setting the X-DNS-Prefetch-Control header.

4.) expectCt

Tells browsers to expect Certificate Transparency. For more about Certificate Transparency and this header, see this blog post and the in-progress spec.

5.) featurePolicy

Lets you restrict which browser features can be used. For example, you can disable fullscreen or vibration APIs.

6.) frameguard (✓)

Frameguard mitigates clickjacking attacks by setting the X-Frame-Options header.

7.) hidePoweredBy (✓)

Removes the X-Powered-By header to make it slightly harder for attackers to see what potentially-vulnerable technology powers your site.

8.) hpkp

Helps you set the Public-Key-Pins header to prevent person-in-the-middle attacks. Usage of this header (and therefore this middleware) is not recommended. Be very careful when deploying this—you can easily misuse this header and cause problems. Chrome dropped support for HPKP citing risks of misuse.

9.) hsts (✓)

This module sets the Strict-Transport-Security header to keep your users on HTTPS.

10.) ieNoOpen (✓)

This middleware sets the X-Download-Options to prevent Internet Explorer from executing downloads in your site’s context.

11.) noCache

Aims to disable browser caching by setting several headers.

12.) noSniff (✓)

Helps prevent browsers from trying to guess (“sniff”) the MIME type, which can have security implications. It does this by setting the X-Content-Type-Options header to nosniff.

13.) referrerPolicy

Can control the behavior of the Referer header by setting the Referrer-Policy header.

14.) xssFilter (✓)

Sets the X-XSS-Protection header to prevent reflected XSS attacks.

Kreiranje projekta

Kreiram mapu projekta ExpressHelmet i unutar nje datoteku server.js

sa sljedećim sadržajem:

var express = require('express');
var app = express(); 
 
var port = process.env.PORT || 8080;
 
var apiRoutes = express.Router();
 
apiRoutes.get('/', function(req, res) {
    res.json({ message: 'API radi!' }); 
});
 
// ostale GET, POST, PUT, DELETE definiraju se u nstavku
 
// sve rute sadržavaju '/api'
app.use('/api', apiRoutes);
 
app.listen(port);
console.log('API je pokrenut i koristi port:' + ' ' + port);

var express = require('express');

var app = express();

var port = process.env.PORT || 8080;

var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {

res.json({ message: 'API radi!' });

});

// ostale GET, POST, PUT, DELETE definiraju se u nstavku

// sve rute sadržavaju '/api'

app.use('/api', apiRoutes);

app.listen(port);

console.log('API je pokrenut i koristi port:' + ' ' + port);

Detalje o tome kako kreirati osnovni Express.js API moguće je pronaći u blog postu pod naslovom Izrada RESTful API-ja koristeći Node.js i Express.js

Ako sada pokrenem API na adresi http://localhost:8080/api unutar Google Chrome Developer alata pod tabom Network dobit ću sljedeće:

Postavljanje Helmet.js-a

Sljedećom naredbom untuar mape projekta instaliram Hellmet.js

$ npm install helmet --save

1	$ npm install helmet --save

Također, unutar server.js datoteke dodajem sljedeće:

var express = require('express');
var app = express();
var helmet = require('helmet');
 
var port = process.env.PORT || 8080; 
 
var apiRoutes = express.Router();
app.use(helmet());
 
apiRoutes.get('/', function(req, res) {
    res.json({ message: 'API radi!' });  
});

// sve rute sadržavati će '/api'
app.use('/api', apiRoutes);
 
app.listen(port);
console.log('API je pokrenut i koristi port:' + ' ' + port);

var express = require('express');

var app = express();

var helmet = require('helmet');

var port = process.env.PORT || 8080;

var apiRoutes = express.Router();

app.use(helmet());

apiRoutes.get('/', function(req, res) {

res.json({ message: 'API radi!' });

});

// sve rute sadržavati će '/api'

app.use('/api', apiRoutes);

app.listen(port);

console.log('API je pokrenut i koristi port:' + ' ' + port);

Ako sada pokrenem API na adresi http://localhost:8080/api unutar Google Chrome Developer alata pod tabom Network dobit ću sljedeće:

Na slici iznad mogu se vidjeti headeri kojih ranije nije bilo, a to su:

Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

Strict-Transport-Security: max-age=15552000; includeSubDomains

X-Content-Type-Options: nosniff

X-DNS-Prefetch-Control: off

X-Download-Options: noopen

X-Frame-Options: SAMEORIGIN

X-XSS-Protection: 1; mode=block

Također, headere mogu vidjeti i pokretanjem sljedeće naredbe:

curl -i http://localhost:8080/api

1	curl -i http://localhost:8080/api

Zaključak

Helmet.js nije “all in one” rješenje niti se njegovim postavljenjem unutar projekta može reći da je sigurnosna zaštita aplikacije gotova, ali je svakako dobar početak procesa razmišljanja o sigurnosti.

Node.js Cron Job – automatsko izvršavanje zakazanih zadataka

Do sada sam objavio nekoliko članaka korištenju NodeJS API-ja i svaki od njih ima istu poveznicu, a to je činjenica da se izvršavaju isključivo kada ih pozovem. U većini slučajeva to tako treba biti, ali postoje i slučajevi u kojima želim da se određeni zadatak izvrši bez da ga ručno moram pokrenuti pozivajući neki API endpoint. U tome će mi pomoći Cron Job.

Postavljanje projekta

Kreiram mapu naziva ExpressNodeCron i unutar nje pokrećem naredbu:

$ npm init --yes

1	$ npm init --yes

Odmah nakon toga instaliram Express.js i Node Cron pakete:

$ npm install express --save
$ npm install node-cron --save

1 2	$ npm install express --save $ npm install node-cron --save

Sada u mapi projekta mogu vidjeti datoteku package.json koja je osnova ovog projekta.

{
  "name": "expressnodecron",
  "version": "1.0.0",
  "description": "ExpressJS Cron exaple",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Tomislav Stanković",
  "license": "ISC",
  "dependencies": {
    "node-cron": "^1.2.1",
    "express": "^4.16.3"
  }
}

{

"name": "expressnodecron",

"version": "1.0.0",

"description": "ExpressJS Cron exaple",

"main": "index.js",

"scripts": {

"test": "echo \"Error: no test specified\" && exit 1"

"author": "Tomislav Stanković",

"license": "ISC",

"dependencies": {

"node-cron": "^1.2.1",

"express": "^4.16.3"

}

Kreiranje API-ja

Unutar datoteke index.js koju sam upravo kreirao kopiram sljedeći sadržaj:

var express = require('express');
var app = express();
var cron = require("node-cron");
 
var port = process.env.PORT || 8080;
 
var apiRoutes = express.Router();
 
apiRoutes.get('/', function(req, res) {
    //ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku
    res.json({ message: 'API radi!' });   
});
 
app.use('/api', apiRoutes);
 
app.listen(port);
console.log('API je pokrenut na portu:' + ' ' + port);

var express = require('express');

var app = express();

var cron = require("node-cron");

var port = process.env.PORT || 8080;

var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {

//ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku

res.json({ message: 'API radi!' });

});

app.use('/api', apiRoutes);

app.listen(port);

console.log('API je pokrenut na portu:' + ' ' + port);

API odmah testiram na putanji http://localhost:8080/api/

Cron Job funkcionalnost

Sada pratim dostupnu dokumentaciju na adresi https://www.npmjs.com/package/node-cron

Na sljedećem primjeru nalazi se osnova cron job funkcionalnosti.

cron.schedule("* * * * *", function() {
    console.log("izvršavanje zadatka svake minute");
});

cron.schedule("* * * * *", function() {

console.log("izvršavanje zadatka svake minute");

});

Na liniji 1 nalazi se "* * * * *" što označava odabrani interval u kojemu će se određeni zadatak izvršiti.

 # ┌────────────── sekunde (opcionalno), vrijednost: 0 - 59
 # │ ┌──────────── minute, vrijednost: 0-59
 # │ │ ┌────────── sati, vrijednost: 0-23
 # │ │ │ ┌──────── dan u mjesecu, vrijednost: 1-31
 # │ │ │ │ ┌────── mjesec, vrijednost: 1-12 (ili nazivi)
 # │ │ │ │ │ ┌──── dan u tjednu, vrijednost: 0-7 (ili nazivi, 0 ili 7 označava nedjelju)
 # │ │ │ │ │ │
 # │ │ │ │ │ │
 # * * * * * *

# ┌────────────── sekunde (opcionalno), vrijednost: 0 - 59

# │ ┌──────────── minute, vrijednost: 0-59

# │ │ ┌────────── sati, vrijednost: 0-23

# │ │ │ ┌──────── dan u mjesecu, vrijednost: 1-31

# │ │ │ │ ┌────── mjesec, vrijednost: 1-12 (ili nazivi)

# │ │ │ │ │ ┌──── dan u tjednu, vrijednost: 0-7 (ili nazivi, 0 ili 7 označava nedjelju)

# │ │ │ │ │ │

# * * * * * *

Na liniji 2 nalazi se zadatak koji će se izvršiti u zadanom intervalu.

Osim ranije spomenutog intervala moguće su i sljedeće kombinacije:

– više vrijednosti odvojenih zarezom

cron.schedule('1,2,4,5 * * * *', function(){
  console.log('izvršavanje nakon 1, 2, 4 i 5 minuta');
});

cron.schedule('1,2,4,5 * * * *', function(){

console.log('izvršavanje nakon 1, 2, 4 i 5 minuta');

});

– korištenje raspona vrijednosti

cron.schedule('1-5 * * * *', function(){
  console.log('izvršavanje zadatka od 1. do 5. minute');
});

cron.schedule('1-5 * * * *', function(){

console.log('izvršavanje zadatka od 1. do 5. minute');

});

– izvršavanje u koracima

cron.schedule('*/2 * * * *', function(){
  console.log('izvršavanje zadataka svake dvije minute');
});

cron.schedule('*/2 * * * *', function(){

console.log('izvršavanje zadataka svake dvije minute');

});

– korištenje naziva mjeseca i dana umjesto brojeva (moraju biti na engleskom jeziku)

cron.schedule('* * * August Sunday', function(){
    console.log('izvršavanje svake nedjelje u osmom mjesecu');
});

cron.schedule('* * * August Sunday', function(){

console.log('izvršavanje svake nedjelje u osmom mjesecu');

});

Svi ranije navedeni zadaci pokreću se prilikom startanja NodeJS servera, ali postoje još i dodatne metode pomoću kojih je moguće u određenom trenutku pokrenuti neki Cron Job, stopirati ga ili skroz ugasiti.

Start task.start();

var cron = require('node-cron');
 
var task = cron.schedule('* * * * *', function() {
  console.log('pokrenuto izvršavanje zadatka');
}, false);
 
task.start();

var cron = require('node-cron');

var task = cron.schedule('* * * * *', function() {

console.log('pokrenuto izvršavanje zadatka');

}, false);

task.start();

Stop task.stop();

Jednom stopirati zadatak moguće je ponovno pokrenuti.

var cron = require('node-cron');
 
var task = cron.schedule('* * * * *', function() {
  console.log('izvršava se svake minute do stopiranja');
});
 
task.stop();

var cron = require('node-cron');

var task = cron.schedule('* * * * *', function() {

console.log('izvršava se svake minute do stopiranja');

});

task.stop();

Primjer:

Pozivanjem putanje http://localhost:8080/api/stopiraj zaustavljam Cron Job.

var task =  cron.schedule("* * * * *", function() {
    console.log("izvršavanje zadatka svake minute", new Date());
});

apiRoutes.get('/stopiraj', function(req, res) {
    task.stop();
    res.json({ message: 'Zadatak zaustavljen!' });   
});

var task = cron.schedule("* * * * *", function() {

console.log("izvršavanje zadatka svake minute", new Date());

});

apiRoutes.get('/stopiraj', function(req, res) {

task.stop();

res.json({ message: 'Zadatak zaustavljen!' });

});

Destroy task.destroy();

Jednom prekinuti zadatak nije moguće ponovno pokrenuti.

var cron = require('node-cron');
 
var task = cron.schedule('* * * * *', function() {
  console.log('neće se više izvršavati, niti ga je moguće ponovno pokrenuti');
});
 
task.destroy();

var cron = require('node-cron');

var task = cron.schedule('* * * * *', function() {

console.log('neće se više izvršavati, niti ga je moguće ponovno pokrenuti');

});

task.destroy();

ExpressJS middleware za ograničavanje ponovljenih zahtjeva na API-je

Jedna od najvažnijih komponenti svakog API-ja, osim mogućnosti upravljanja podacima, je sigurnost. A jedna od osnovnih komponenti te sigurnosti je mogućnost blokiranja prekomjernih upita koji se šalju na pojedini API endpoint.

U ovom ću slučaju za tu svrhu koristiti Express Rate Limit modul.

Postavljanje projekta

Kreiram mapu naziva ExpressRateLimit i unutar nje pokrećem naredbu:

$ npm init --yes

1	$ npm init --yes

Odmah nakon toga instaliram Express.js i Express Rate Limit pakete:

$ npm install express --save
$ npm install --save express-rate-limit

1 2	$ npm install express --save $ npm install --save express-rate-limit

Sada u mapi projekta mogu vidjeti datoteku package.json koja je osnova ovog projekta.

{
  "name": "ExpressRateLimit",
  "version": "1.0.0",
  "description": "ExpressJS Rate Limit API",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "express": "^4.16.3",
    "express-rate-limit": "^2.12.2"
  }
}

{

"name": "ExpressRateLimit",

"version": "1.0.0",

"description": "ExpressJS Rate Limit API",

"main": "index.js",

"scripts": {

"test": "echo \"Error: no test specified\" && exit 1"

"keywords": [],

"author": "",

"license": "ISC",

"dependencies": {

"express": "^4.16.3",

"express-rate-limit": "^2.12.2"

}

Sada imam sve potrebno za kreiranje API-ja.

Kreiranje API-ja

Kreiram index.js datoteku unutar koje kopiram sljedeći sadržaj:

var express = require('express');
var app = express();
var RateLimit = require('express-rate-limit');
 
var port = process.env.PORT || 8080;
 
var apiRoutes = express.Router();
 
apiRoutes.get('/', function(req, res) {
    //ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku
    res.json({ message: 'API radi!' });   
});
 
app.use('/api', apiRoutes);
 
app.listen(port);
console.log('API je pokrenut na portu:' + ' ' + port);

var express = require('express');

var app = express();

var RateLimit = require('express-rate-limit');

var port = process.env.PORT || 8080;

var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {

//ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku

res.json({ message: 'API radi!' });

});

app.use('/api', apiRoutes);

app.listen(port);

console.log('API je pokrenut na portu:' + ' ' + port);

API mogu testirati na putanji http://localhost:8080/api/

Sada, nakon što sam se uvjerio da API ispravno radi, mogu implementirati Express Rate Limit modul.

Express Rate Limit modul

Kreiram dvije krajnje točke (endpoint):

apiRoutes.get('/putanja1', function(req, res) {
    res.json({ 
	success: true,
	message: 'Prvi API' });   
});
 
apiRoutes.get('/putanja2', function(req, res) {
    res.json({ 
	success: true,
	message: 'Drugi API' });   
});

apiRoutes.get('/putanja1', function(req, res) {

res.json({

success: true,

message: 'Prvi API' });

});

apiRoutes.get('/putanja2', function(req, res) {

res.json({

success: true,

message: 'Drugi API' });

});

Njima pristupam putem URL-ova:

http://localhost:8080/api/putanja1 i http://localhost:8080/api/putanja2

Prije nego ubacim sigurnosnu zaštitu URL-ovima je moguće pristupiti neograničeno mnogo puta. Ovo nije problem kada, kao u ovom konkretnom slučaju, šaljem mali json objekt, ali kada je u pitanju API koji dohvaća više podataka iz npr. SQL baze onda to već postaje problem jer može doći do zagušenja ili potpunog blokiranja servera.

Sada ću dodati apiLimiter objekt s nekoliko parametara.

var apiLimiter= new RateLimit({
  windowMs: 60*60*1000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila
  delayAfter: 1, // započeti usporavanje nakon prvog upita
  delayMs: 3*1000, // usporiti svaki sljedeći upit za 3 sekunde
  max: 5, // blokiranje API-ja nakon 5 upita
  message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno za jedan sat"
});

var apiLimiter= new RateLimit({

windowMs: 60*60*1000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila

delayAfter: 1, // započeti usporavanje nakon prvog upita

delayMs: 3*1000, // usporiti svaki sljedeći upit za 3 sekunde

max: 5, // blokiranje API-ja nakon 5 upita

message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno za jedan sat"

});

Ako želim da se ta pravila primjene na sve krajnje točke (endpoint) dodajem sljedeće:

app.use('/api/', apiLimiter, apiRoutes);

1	app.use('/api/', apiLimiter, apiRoutes);

Mogu vidjeti da je svaki sljedeći upit sporiji od prethodnog i da se nakon 5 poslanih upita prikazuje poruka iz apiLimiter objekta.

U slučaju da za svaku krajnju točku tj. svaki endpoint želim postaviti drugačiji uvijet to radim tako da kreiram toliki broj objekata koliko ima krajnjih čvorova. Npr.

var apiLimiter1 = new RateLimit({
  windowMs: 60000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila
  delayAfter: 10, // započeti usporavanje nakon prvog upita
  delayMs: 1000, // usporiti svaki sljedeći upit za 3 sekunde
  max: 50, // blokiranje API-ja nakon 5 upita
  message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno kasnije"
});

var apiLimiter2 = new RateLimit({
  windowMs: 60*60*1000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila
  delayAfter: 1, // započeti usporavanje nakon prvog upita
  delayMs: 3*1000, // usporiti svaki sljedeći upit za 3 sekunde
  max: 5, // blokiranje API-ja nakon 5 upita
  message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno za jedan sat"
});
 
apiRoutes.get('/', function(req, res, next) {
    //ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku
    res.json({ message: 'API radi!' });   
});

apiRoutes.get('/putanja1', apiLimiter1, function(req, res, next) {
    res.json({ 
	success: true,
	message: 'Prvi API' });   
});
 
apiRoutes.get('/putanja2', apiLimiter2, function(req, res, next) {
    res.json({ 
	success: true,
	message: 'Drugi API' });   
});

var apiLimiter1 = new RateLimit({

windowMs: 60000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila

delayAfter: 10, // započeti usporavanje nakon prvog upita

delayMs: 1000, // usporiti svaki sljedeći upit za 3 sekunde

max: 50, // blokiranje API-ja nakon 5 upita

message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno kasnije"

});

var apiLimiter2 = new RateLimit({

windowMs: 60*60*1000, // vremenski okvir od jednog sata unutar kojega vrijede ova pravila

delayAfter: 1, // započeti usporavanje nakon prvog upita

delayMs: 3*1000, // usporiti svaki sljedeći upit za 3 sekunde

max: 5, // blokiranje API-ja nakon 5 upita

message: "Previse zahtjeva s Vase IP, molimo pokusajte ponovno za jedan sat"

});

apiRoutes.get('/', function(req, res, next) {

//ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku

res.json({ message: 'API radi!' });

});

apiRoutes.get('/putanja1', apiLimiter1, function(req, res, next) {

res.json({

success: true,

message: 'Prvi API' });

});

apiRoutes.get('/putanja2', apiLimiter2, function(req, res, next) {

res.json({

success: true,

message: 'Drugi API' });

});

Nodemailer & NodeJS – API za slanje emaila

Cilj ovog blog posta je pokazati kako napraviti API za slanje emaila. To ću postići koristeći NodeJS, ExpressJS, Nodemailer i naravno Gmail.

Postavljanje projekta

Kreiram mapu za projekt i unutar nje pokrećem naredbu

$ npm init --yes

1	$ npm init --yes

i odmah nakon toga instaliram potrebne NPM pakete:

– Express.js: $ npm install express --save
– Nodemailer: $ npm install nodemailer--save
– bodyParser: $ npm install body-parser -save

Struktura projekta prema package.json sada izgleda ovako:

{
  "name": "NodemailerAPI",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "Tomislav Stanković",
  "license": "ISC",
  "dependencies": {
    "body-parser": "^1.18.3",
    "express": "^4.16.3",
    "nodemailer": "^4.6.7"
  }
}

{

"name": "NodemailerAPI",

"version": "1.0.0",

"description": "",

"main": "index.js",

"scripts": {

"test": "echo \"Error: no test specified\" && exit 1"

"keywords": [],

"author": "Tomislav Stanković",

"license": "ISC",

"dependencies": {

"body-parser": "^1.18.3",

"express": "^4.16.3",

"nodemailer": "^4.6.7"

}

Sada imam sve spremno za kreiranje datoteke unutar koje će se nalaziti logika API-ja.

'use strict';
var nodemailer = require('nodemailer');
var express = require('express');
var app = express();
var bodyParser = require('body-parser');
 
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
 
var port = process.env.PORT || 8080;
 
var apiRoutes = express.Router();
 
apiRoutes.get('/', function(req, res) {
    res.json({ message: 'API radi!' });   //ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku
});
 
app.use('/api', apiRoutes);
 
app.listen(port);
console.log('API je pokrenut na portu:' + ' ' + port);

'use strict';

var nodemailer = require('nodemailer');

var express = require('express');

var app = express();

var bodyParser = require('body-parser');

app.use(bodyParser.urlencoded({ extended: true }));

app.use(bodyParser.json());

var port = process.env.PORT || 8080;

var apiRoutes = express.Router();

apiRoutes.get('/', function(req, res) {

res.json({ message: 'API radi!' }); //ako je sve ispravno postavljeno kao odgovor dobijem ovu poruku

});

app.use('/api', apiRoutes);

app.listen(port);

console.log('API je pokrenut na portu:' + ' ' + port);

API sada mogu i pokrenuti te se uvjeriti da radi. Pokrećem ga naredbom u kojoj riječ “index” označava naziv .js datoteke.

$ node index

1	$ node index

To je mogla biti i npr. server.js datoteka. U tom bi slučaju API pokrenuo naredbom $ node server.

Na adresi http://localhost:8080/api mogu vidjeti da je API uspješno pokrenut.

Slanje testnog e-maila

Unutar datoteke index.js sada ću kreirati API za slanje e-maila.

var transporter = nodemailer.createTransport('smtps://GmailKorisnickoIme:GmailLozinka@smtp.gmail.com');

apiRoutes.post('/posaljiEmail', function(req, res) {
    nodemailer.createTestAccount((err, account) => {
	var smtpTransport = nodemailer.createTransport({
    host: "smtp.gmail.com",
	secureConnection: false,
    port: 587,
    auth: {
        user: "GmailKorisnickoIme",
        pass: "GmailLozinka"
    }
});

    let mailOptions = {
        from: '"NodemailerAPI" <demo@example.com>', // pošiljatelj
        to: '*s*a*k*@efos.hr, t*m*s*a*s*a*k*v*c*@gmail.com', // popis primatelja
        subject: 'Email poslam putem Nodemailera', // naslov
        text: 'Ovo je sadržaj maila.', // sadržaj poruke
        html: '<h2>Pozdrav!</h2><br><b>Ovo je formatiran sadržaj maila!</b>' // formatiran sadržaj poruke
    };

    transporter.sendMail(mailOptions, (error, info) => {
        if (error) {
            return console.log(error);
        }
        console.log('E-mail poslan: %s', info.messageId);
    });
});
});

var transporter = nodemailer.createTransport('smtps://GmailKorisnickoIme:GmailLozinka@smtp.gmail.com');

apiRoutes.post('/posaljiEmail', function(req, res) {

nodemailer.createTestAccount((err, account) => {

var smtpTransport = nodemailer.createTransport({

host: "smtp.gmail.com",

secureConnection: false,

port: 587,

auth: {

user: "GmailKorisnickoIme",

pass: "GmailLozinka"

}

});

let mailOptions = {

from: '"NodemailerAPI" <demo@example.com>', // pošiljatelj

to: '*s*a*k*@efos.hr, t*m*s*a*s*a*k*v*c*@gmail.com', // popis primatelja

subject: 'Email poslam putem Nodemailera', // naslov

text: 'Ovo je sadržaj maila.', // sadržaj poruke

html: '<h2>Pozdrav!</h2><br><b>Ovo je formatiran sadržaj maila!</b>' // formatiran sadržaj poruke

};

transporter.sendMail(mailOptions, (error, info) => {

if (error) {

return console.log(error);

}

console.log('E-mail poslan: %s', info.messageId);

});

S obzirom na parametar secureConnection: false vrlo je važno da omogućim dopuštanje nesigurnijim aplikacijama da pristupe računu na adresi https://myaccount.google.com/security?pli=1

Jer ako to ne napravim dobit ću poruku o grešci što znači da e-mail neće biti poslan/primljen. Ovaj dio mi je zadavao najviše problema prije dvije godine kada sam prvi put radio Nodemailer API. U pitanju je bila funkcionalnost vezana uz resetiranje lozinke.

Ako sada putem Postmana pokrenem POST zahtjev na adresu http://localhost:8080/api/posaljiEmail vrlo brzo će mi stići e-mail.

Zašto se u slici iznad kao adresa primatelja nalazi drugačija adresa od one navedene gore u API-ju? To je zbog postavki unutar Gmaila gdje je navedeno da je adresa k*n*a*t@tomislavstankovic.com zadana adresa pošiljatelja. S obzirom da ovdje koristim Gmail kao servis za slanje e-maila jasno je da će on uzeti te zadane postavke.

E-mail sa “pravim” podacima

U gornjem sam se primjeru uvjerio da moj Nodemailer API uredno radi, a sada želim imati mogućnost određivanja na koju adresu i koji sadržaj želim poslati.

API sada izgleda ovako:

apiRoutes.post('/posaljiEmail', function(req, res) {
 if(req.body.emailPrimatelj == "" || req.body.naslov == "" || req.body.poruka == ""){
     return false;
 } else {
    nodemailer.createTestAccount((err, account) => {
        var smtpTransport = nodemailer.createTransport({
        host: "smtp.gmail.com",
        secureConnection: false,
        port: 587,
        auth: {
            user: "GmailKorisnickoIme",
            pass: "GmailLozinka"
        }
    });
    
        let mailOptions = {
            from: '"NodemailerAPI" <demo@example.com>', // pošiljatelj
            to: req.body.emailPrimatelj, // popis primatelja
            subject: req.body.naslov, // naslov
            text: req.body.poruka, // sadržaj poruke
            html: '<b>' + req.body.poruka + '</b>' // formatiran sadržaj poruke
        };
    
        transporter.sendMail(mailOptions, (error, info) => {
            if (error) {
                res.json({ 
                    poruka: "Nisu uneseni potrebni podaci! E-mail nije poslan!",
                    greska: error,
                    status: false }); 
                return console.log(error);
            } else {
                return console.log(info);
            }
            console.log('E-mail poslan: %s', info.messageId);
        });
    });
 }  
});

apiRoutes.post('/posaljiEmail', function(req, res) {

if(req.body.emailPrimatelj == "" || req.body.naslov == "" || req.body.poruka == ""){

return false;

} else {

nodemailer.createTestAccount((err, account) => {

var smtpTransport = nodemailer.createTransport({

host: "smtp.gmail.com",

secureConnection: false,

port: 587,

auth: {

user: "GmailKorisnickoIme",

pass: "GmailLozinka"

}

});

let mailOptions = {

from: '"NodemailerAPI" <demo@example.com>', // pošiljatelj

to: req.body.emailPrimatelj, // popis primatelja

subject: req.body.naslov, // naslov

text: req.body.poruka, // sadržaj poruke

html: '<b>' + req.body.poruka + '</b>' // formatiran sadržaj poruke

};

transporter.sendMail(mailOptions, (error, info) => {

if (error) {

res.json({

poruka: "Nisu uneseni potrebni podaci! E-mail nije poslan!",

greska: error,

status: false });

return console.log(error);

} else {

return console.log(info);

}

console.log('E-mail poslan: %s', info.messageId);

});

}

});

Ovdje se može vidjeti da podatke šaljem kroz req.body i upravo je to razlog zbog kojeg koristim body-parser. U slučaju da nisam koristio body-parser dobio bi sljedeću grešku.

Također, ako ne unesem sve potrebne podatke body-parser neće imati s čime raditi i opet ću dobiti grešku. U ovom slučaju nisam poslao e-mail adresu primatelja.

Nakon što unesem sve potrebne podatke, body-parser će odraditi svoje i e-mail će biti uspješno poslan/primljen.